/[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.132 Revision 1.157
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-2011, 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.132 2010/02/12 23:51:44 caster Exp $ 9# $Header: /var/cvsroot/gentoo-x86/eclass/java-utils-2.eclass,v 1.157 2015/04/04 21:04:49 chewi 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# -----------------------------------------------------------------------------
66hasq "${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.1.9-r1 ${JAVA_PKG_PORTAGE_DEP}"
76hasq source ${JAVA_PKG_IUSE} && JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} source? ( app-arch/zip )" 47has source ${JAVA_PKG_IUSE} && JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} source? ( app-arch/zip )"
77 48
78# ----------------------------------------------------------------------------- 49# @ECLASS-VARIABLE: JAVA_PKG_WANT_BOOTCLASSPATH
79# @variable-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# @VARIABLE: JAVA_PKG_COMPILER_DIR
148# @variable-internal JAVA_PKG_COMPILER_DIR 130# @INTERNAL
149# @default /usr/share/java-config-2/compiler 131# @DESCRIPTION:
150#
151# Directory where compiler settings are saved, without trailing slash. 132# Directory where compiler settings are saved, without trailing slash.
152# Probably shouldn't touch this variable. 133# 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"} 134JAVA_PKG_COMPILER_DIR=${JAVA_PKG_COMPILER_DIR:="/usr/share/java-config-2/compiler"}
155 135
156 136# @VARIABLE: JAVA_PKG_COMPILERS_CONF
157# ----------------------------------------------------------------------------- 137# @INTERNAL
158# @variable-internal JAVA_PKG_COMPILERS_CONF 138# @DESCRIPTION:
159# @variable-default /etc/java-config-2/build/compilers.conf
160#
161# Path to file containing information about which compiler to use. 139# Path to file containing information about which compiler to use.
162# Can be overloaded, but it should be overloaded for testing. 140# 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"} 141JAVA_PKG_COMPILERS_CONF=${JAVA_PKG_COMPILERS_CONF:="/etc/java-config-2/build/compilers.conf"}
165 142
166# ----------------------------------------------------------------------------- 143# @ECLASS-VARIABLE: JAVA_PKG_FORCE_COMPILER
167# @variable-external JAVA_PKG_FORCE_COMPILER 144# @INTERNAL
168# 145# @DEFAULT_UNSET
146# @DESCRIPTION:
169# Explicitly set a list of compilers to use. This is normally read from 147# Explicitly set a list of compilers to choose from. This is normally read from
170# JAVA_PKG_COMPILERS_CONF. 148# JAVA_PKG_COMPILERS_CONF.
171# 149#
172# @note This should only be used internally or for testing. 150# Useful for local testing.
151#
173# @example Use jikes and javac, in that order 152# Use jikes and javac, in that order
153# @CODE
174# JAVA_PKG_FORCE_COMPILER="jikes javac" 154# JAVA_PKG_FORCE_COMPILER="jikes javac"
175# ----------------------------------------------------------------------------- 155# @CODE
176 156
177# ----------------------------------------------------------------------------- 157# @ECLASS-VARIABLE: JAVA_PKG_FORCE_ANT_TASKS
178# @variable-external JAVA_PKG_FORCE_ANT_TASKS 158# @DEFAULT_UNSET
179# 159# @DESCRIPTION:
180# An $IFS separated list of ant tasks. Can be set in environment before calling 160# An $IFS separated list of ant tasks. Can be set in environment before calling
181# emerge/ebuild to override variables set in ebuild, mainly for testing before 161# emerge/ebuild to override variables set in ebuild, mainly for testing before
182# putting the resulting (WANT_)ANT_TASKS into ebuild. Affects only ANT_TASKS in 162# putting the resulting (WANT_)ANT_TASKS into ebuild. Affects only ANT_TASKS in
183# eant() call, not the dependencies specified in WANT_ANT_TASKS. 163# eant() call, not the dependencies specified in WANT_ANT_TASKS.
184# 164#
165# @CODE
185# @example JAVA_PKG_FORCE_ANT_TASKS="ant-junit ant-trax" \ 166# JAVA_PKG_FORCE_ANT_TASKS="ant-junit ant-trax" \
186# ebuild foo.ebuild compile 167# ebuild foo.ebuild compile
187# 168# @CODE
188# @seealso WANT_ANT_TASKS
189# -----------------------------------------------------------------------------
190 169
191# TODO document me 170# TODO document me
192JAVA_PKG_QA_VIOLATIONS=0 171JAVA_PKG_QA_VIOLATIONS=0
193 172
194# ----------------------------------------------------------------------------- 173# @FUNCTION: java-pkg_doexamples
195# @section-end variables 174# @USAGE: [--subdir <subdir>] <file1/dir1> [<file2> ...]
196# ----------------------------------------------------------------------------- 175# @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 176# 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 177# If you give it only one parameter and it is a directory it will install
212# everything in that directory to the examples directory. 178# everything in that directory to the examples directory.
213# 179#
180# @CODE
181# Parameters:
182# --subdir - If the examples need a certain directory structure
183# $* - list of files to install
184#
214# @example 185# Examples:
215# java-pkg_doexamples demo 186# java-pkg_doexamples demo
216# java-pkg_doexamples demo/* examples/* 187# java-pkg_doexamples demo/* examples/*
217# 188# @CODE
218# @param --subdir - If the examples need a certain directory structure
219# @param $* - list of files to install
220# ------------------------------------------------------------------------------
221java-pkg_doexamples() { 189java-pkg_doexamples() {
222 debug-print-function ${FUNCNAME} $* 190 debug-print-function ${FUNCNAME} $*
223 191
224 [[ ${#} -lt 1 ]] && die "At least one argument needed" 192 [[ ${#} -lt 1 ]] && die "At least one argument needed"
225 193
226 java-pkg_check-phase install 194 java-pkg_check-phase install
195 java-pkg_init_paths_
227 196
228 local dest=/usr/share/doc/${PF}/examples 197 local dest=/usr/share/doc/${PF}/examples
229 if [[ ${1} == --subdir ]]; then 198 if [[ ${1} == --subdir ]]; then
230 local dest=${dest}/${2} 199 local dest=${dest}/${2}
231 dodir ${dest} 200 dodir ${dest}
241 ( # dont want to pollute calling env 210 ( # dont want to pollute calling env
242 insinto "${dest}" 211 insinto "${dest}"
243 doins -r "$@" 212 doins -r "$@"
244 ) || die "Installing examples failed" 213 ) || die "Installing examples failed"
245 fi 214 fi
246}
247 215
248# ----------------------------------------------------------------------------- 216 # Let's make a symlink to the directory we have everything else under
249# @ebuild-function java-pkg_dojar 217 dosym "${dest}" "${JAVA_PKG_SHAREPATH}/examples" || die
250# 218}
219
220# @FUNCTION: java-pkg_dojar
221# @USAGE: <jar1> [<jar2> ...]
222# @DESCRIPTION:
251# Installs any number of jars. 223# Installs any number of jars.
252# Jar's will be installed into /usr/share/${PN}(-${SLOT})/lib/ by default. 224# Jar's will be installed into /usr/share/${PN}(-${SLOT})/lib/ by default.
253# You can use java-pkg_jarinto to change this path. 225# You can use java-pkg_jarinto to change this path.
254# You should never install a jar with a package version in the filename. 226# You should never install a jar with a package version in the filename.
255# Instead, use java-pkg_newjar defined below. 227# Instead, use java-pkg_newjar defined below.
256# 228#
257# @example 229# @CODE
258# java-pkg_dojar dist/${PN}.jar dist/${PN}-core.jar 230# java-pkg_dojar dist/${PN}.jar dist/${PN}-core.jar
231# @CODE
259# 232#
260# @param $* - list of jars to install 233# @param $* - list of jars to install
261# ------------------------------------------------------------------------------
262java-pkg_dojar() { 234java-pkg_dojar() {
263 debug-print-function ${FUNCNAME} $* 235 debug-print-function ${FUNCNAME} $*
264 236
265 [[ ${#} -lt 1 ]] && die "At least one argument needed" 237 [[ ${#} -lt 1 ]] && die "At least one argument needed"
266 238
308 done 280 done
309 281
310 java-pkg_do_write_ 282 java-pkg_do_write_
311} 283}
312 284
313# ------------------------------------------------------------------------------ 285# @FUNCTION: depend-java-query
314# @internal-function depend-java-query 286# @INTERNAL
315# 287# @DESCRIPTION:
316# Wrapper for the depend-java-query binary to enable passing USE in env. 288# Wrapper for the depend-java-query binary to enable passing USE in env.
317# Using env variables keeps this eclass working with java-config versions that 289# Using env variables keeps this eclass working with java-config versions that
318# do not handle use flags. 290# do not handle use flags.
319# ------------------------------------------------------------------------------
320
321depend-java-query() { 291depend-java-query() {
322 # Used to have a which call here but it caused endless loops for some people 292 # Used to have a which call here but it caused endless loops for some people
323 # that had some weird bashrc voodoo for which. 293 # that had some weird bashrc voodoo for which.
324 USE="${USE}" /usr/bin/depend-java-query "${@}" 294 USE="${USE}" /usr/bin/depend-java-query "${@}"
325} 295}
326 296
327# ------------------------------------------------------------------------------ 297# @FUNCTION: java-pkg_regjar
328# @ebuild-function java-pkg_regjar 298# @USAGE: </path/to/installed/jar>
329# 299# @DESCRIPTION:
330# Records an already installed jar in the package.env 300# Records an already installed (in ${D}) jar in the package.env
331# This would mostly be used if the package has make or a custom script to 301# This would mostly be used if the package has make or a custom script to
332# install things. 302# install things.
333# 303#
334# Example:
335# java-pkg_regjar ${D}/opt/foo/lib/foo.jar
336#
337# WARNING: 304# WARNING:
338# if you want to use shell expansion, you have to use ${D}/... as the for in 305# if you want to use shell expansion, you have to use ${D}/... as the for in
339# this function will not be able to expand the path, here's an example: 306# this function will not be able to expand the path, here's an example:
340# 307#
341# java-pkg_regjar /opt/my-java/lib/*.jar 308# @CODE
342#
343# will not work, because:
344# * the `for jar in "$@"` can't expand the path to jar file names, as they
345# don't exist yet
346# * all `if ...` inside for will fail - the file '/opt/my-java/lib/*.jar'
347# doesn't exist
348#
349# you have to use it as:
350#
351# java-pkg_regjar ${D}/opt/my-java/lib/*.jar 309# java-pkg_regjar ${D}/opt/my-java/lib/*.jar
310# @CODE
352# 311#
353# @param $@ - jars to record 312
354# ------------------------------------------------------------------------------
355# TODO should we be making sure the jar is present on ${D} or wherever? 313# TODO should we be making sure the jar is present on ${D} or wherever?
356java-pkg_regjar() { 314java-pkg_regjar() {
357 debug-print-function ${FUNCNAME} $* 315 debug-print-function ${FUNCNAME} $*
358 316
359 java-pkg_check-phase install 317 java-pkg_check-phase install
390 done 348 done
391 349
392 java-pkg_do_write_ 350 java-pkg_do_write_
393} 351}
394 352
395# ------------------------------------------------------------------------------ 353# @FUNCTION: java-pkg_newjar
396# @ebuild-function java-pkg_newjar 354# @USAGE: <path/to/oldname.jar> [<newname.jar>]
355# @DESCRIPTION:
356# Installs a jar with a new name (defaults to $PN.jar)
397# 357#
398# Installs a jar with a new name
399#
400# @example: install a versioned jar without the version 358# For example, installs a versioned jar without the version
401# java-pkg_newjar dist/${P}.jar ${PN}.jar
402#
403# @param $1 - jar to install
404# @param $2 - new name for jar - defaults to ${PN}.jar if not specified
405# ------------------------------------------------------------------------------
406java-pkg_newjar() { 359java-pkg_newjar() {
407 debug-print-function ${FUNCNAME} $* 360 debug-print-function ${FUNCNAME} $*
408 361
409 local original_jar="${1}" 362 local original_jar="${1}"
410 local new_jar="${2:-${PN}.jar}" 363 local new_jar="${2:-${PN}.jar}"
418 cp "${original_jar}" "${new_jar_dest}" \ 371 cp "${original_jar}" "${new_jar_dest}" \
419 || die "Failed to copy ${original_jar} to ${new_jar_dest}" 372 || die "Failed to copy ${original_jar} to ${new_jar_dest}"
420 java-pkg_dojar "${new_jar_dest}" 373 java-pkg_dojar "${new_jar_dest}"
421} 374}
422 375
423# ------------------------------------------------------------------------------ 376# @FUNCTION: java-pkg_addcp
424# @ebuild-function java-pkg_addcp 377# @USAGE: <classpath>
425# 378# @DESCRIPTION:
426# Add something to the package's classpath. For jars, you should use dojar, 379# Add something to the package's classpath. For jars, you should use dojar,
427# newjar, or regjar. This is typically used to add directories to the classpath. 380# newjar, or regjar. This is typically used to add directories to the classpath.
428# 381# The parameters of this function are appended to JAVA_PKG_CLASSPATH
429# TODO add example
430# @param $@ - value to append to JAVA_PKG_CLASSPATH
431# ------------------------------------------------------------------------------
432java-pkg_addcp() { 382java-pkg_addcp() {
433 java-pkg_append_ JAVA_PKG_CLASSPATH "${@}" 383 java-pkg_append_ JAVA_PKG_CLASSPATH "${@}"
434 java-pkg_do_write_ 384 java-pkg_do_write_
435} 385}
436 386
437# ------------------------------------------------------------------------------ 387# @FUNCTION: java-pkg_doso
438# @ebuild-function java-pkg_doso 388# @USAGE: <path/to/file1.so> [...]
439# 389# @DESCRIPTION:
440# Installs any number of JNI libraries 390# Installs any number of JNI libraries
441# They will be installed into /usr/lib by default, but java-pkg_sointo 391# They will be installed into /usr/lib by default, but java-pkg_sointo
442# can be used change this path 392# can be used change this path
443# 393#
394# @CODE
444# Example: 395# Example:
445# java-pkg_doso *.so 396# java-pkg_doso *.so
446# 397# @CODE
447# @param $@ - JNI libraries to install
448# ------------------------------------------------------------------------------
449java-pkg_doso() { 398java-pkg_doso() {
450 debug-print-function ${FUNCNAME} $* 399 debug-print-function ${FUNCNAME} $*
451 400
452 java-pkg_check-phase install 401 java-pkg_check-phase install
453 402
479 done 428 done
480 429
481 java-pkg_do_write_ 430 java-pkg_do_write_
482} 431}
483 432
484# ------------------------------------------------------------------------------ 433# @FUNCTION: java-pkg_regso
485# @ebuild-function java-pkg_regso 434# @USAGE: <file1.so> [...]
486# 435# @DESCRIPTION:
487# Registers an already JNI library in package.env. 436# Registers an already installed JNI library in package.env.
437#
438# @CODE
439# Parameters:
440# $@ - JNI libraries to register
488# 441#
489# Example: 442# Example:
490# java-pkg_regso *.so /path/*.so 443# java-pkg_regso *.so /path/*.so
491# 444# @CODE
492# @param $@ - JNI libraries to register
493# ------------------------------------------------------------------------------
494java-pkg_regso() { 445java-pkg_regso() {
495 debug-print-function ${FUNCNAME} $* 446 debug-print-function ${FUNCNAME} $*
496 447
497 java-pkg_check-phase install 448 java-pkg_check-phase install
498 449
516 done 467 done
517 468
518 java-pkg_do_write_ 469 java-pkg_do_write_
519} 470}
520 471
521# ------------------------------------------------------------------------------ 472# @FUNCTION: java-pkg_jarinto
522# @ebuild-function java-pkg_jarinto 473# @USAGE: </path/to/install/jars/into>
523# 474# @DESCRIPTION:
524# Changes the path jars are installed into 475# Changes the path jars are installed into via subsequent java-pkg_dojar calls.
525#
526# @param $1 - new location to install jars into.
527# -----------------------------------------------------------------------------
528java-pkg_jarinto() { 476java-pkg_jarinto() {
529 debug-print-function ${FUNCNAME} $* 477 debug-print-function ${FUNCNAME} $*
530 478
531 JAVA_PKG_JARDEST="${1}" 479 JAVA_PKG_JARDEST="${1}"
532} 480}
533 481
534# ------------------------------------------------------------------------------ 482# @FUNCTION: java-pkg_sointo
535# @ebuild-function java-pkg_sointo 483# @USAGE: </path/to/install/sofiles/into>
536# 484# @DESCRIPTION:
537# Changes the path that JNI libraries are installed into. 485# Changes the path that JNI libraries are installed into via subsequent
538# 486# java-pkg_doso calls.
539# @param $1 - new location to install JNI libraries into.
540# ------------------------------------------------------------------------------
541java-pkg_sointo() { 487java-pkg_sointo() {
542 debug-print-function ${FUNCNAME} $* 488 debug-print-function ${FUNCNAME} $*
543 489
544 JAVA_PKG_LIBDEST="${1}" 490 JAVA_PKG_LIBDEST="${1}"
545} 491}
546 492
547# ------------------------------------------------------------------------------ 493# @FUNCTION: java-pkg_dohtml
548# @ebuild-function java-pkg_dohtml 494# @USAGE: <path/to/javadoc/documentation> [...]
495# @DESCRIPTION:
496# Install Javadoc HTML documentation. Usage of java-pkg_dojavadoc is preferred.
549# 497#
550# Install Javadoc HTML documentation 498# @CODE
551#
552# @example
553# java-pkg_dohtml dist/docs/ 499# java-pkg_dohtml dist/docs/
554# 500# @CODE
555# ------------------------------------------------------------------------------
556java-pkg_dohtml() { 501java-pkg_dohtml() {
557 debug-print-function ${FUNCNAME} $* 502 debug-print-function ${FUNCNAME} $*
558 503
559 [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}" 504 [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}"
560 505
566 # a reasonable way to catch # docs for all of the 511 # a reasonable way to catch # docs for all of the
567 # old ebuilds. 512 # old ebuilds.
568 java-pkg_recordjavadoc 513 java-pkg_recordjavadoc
569} 514}
570 515
571# ------------------------------------------------------------------------------ 516# @FUNCTION: java-pkg_dojavadoc
572# @ebuild-function java-pkg_dojavadoc 517# @USAGE: [--symlink destination] <path/to/javadocs/root>
573# 518# @DESCRIPTION:
574# Installs javadoc documentation. This should be controlled by the doc use flag. 519# Installs javadoc documentation. This should be controlled by the doc use flag.
575# 520#
521# @CODE
522# Parameters:
576# @param $1: optional --symlink creates to symlink like this for html 523# $1: optional --symlink creates to symlink like this for html
577# documentation bundles. 524# documentation bundles.
578# @param $2: - The javadoc root directory. 525# $2: - The javadoc root directory.
579# 526#
580# @example: 527# Examples:
581# java-pkg_dojavadoc docs/api 528# java-pkg_dojavadoc docs/api
582# java-pkg_dojavadoc --symlink apidocs docs/api 529# java-pkg_dojavadoc --symlink apidocs docs/api
583# 530# @CODE
584# ------------------------------------------------------------------------------
585java-pkg_dojavadoc() { 531java-pkg_dojavadoc() {
586 debug-print-function ${FUNCNAME} $* 532 debug-print-function ${FUNCNAME} $*
587 533
588 # For html documentation bundles that link to Javadoc 534 # For html documentation bundles that link to Javadoc
589 local symlink 535 local symlink
596 local dest=/usr/share/doc/${PF}/html 542 local dest=/usr/share/doc/${PF}/html
597 543
598 # QA checks 544 # QA checks
599 545
600 java-pkg_check-phase install 546 java-pkg_check-phase install
547 java-pkg_init_paths_
601 548
602 [[ -z "${dir}" ]] && die "Must specify a directory!" 549 [[ -z "${dir}" ]] && die "Must specify a directory!"
603 [[ ! -d "${dir}" ]] && die "${dir} does not exist, or isn't a directory!" 550 [[ ! -d "${dir}" ]] && die "${dir} does not exist, or isn't a directory!"
604 if [[ ! -e "${dir}/index.html" ]]; then 551 if [[ ! -e "${dir}/index.html" ]]; then
605 local msg="No index.html in javadoc directory" 552 local msg="No index.html in javadoc directory"
632 debug-print "symlinking ${dest}/{api,${symlink}}" 579 debug-print "symlinking ${dest}/{api,${symlink}}"
633 dosym ${dest}/{api,${symlink}} || die 580 dosym ${dest}/{api,${symlink}} || die
634 fi 581 fi
635} 582}
636 583
637# ------------------------------------------------------------------------------ 584# @FUNCTION: java-pkg_dosrc
638# @ebuild-function java-pkg_dosrc 585# @USAGE: <path/to/sources> [...]
639# 586# @DESCRIPTION:
640# Installs a zip containing the source for a package, so it can used in 587# Installs a zip containing the source for a package, so it can used in
641# from IDEs like eclipse and netbeans. 588# from IDEs like eclipse and netbeans.
589# Ebuild needs to DEPEND on app-arch/zip to use this. It also should be controlled by USE=source.
642# 590#
643# Ebuild needs to DEPEND on app-arch/zip to use this. 591# @CODE
644#
645# It also should be controlled by USE=source.
646#
647# @example: 592# Example:
648# java-pkg_dosrc src/* 593# java-pkg_dosrc src/*
649# 594# @CODE
650# ------------------------------------------------------------------------------ 595
651# TODO change so it the arguments it takes are the base directories containing 596# TODO change so it the arguments it takes are the base directories containing
652# source -nichoj 597# source -nichoj
598#
653# TODO should we be able to handle multiple calls to dosrc? -nichoj 599# TODO should we be able to handle multiple calls to dosrc? -nichoj
600#
654# TODO maybe we can take an existing zip/jar? -nichoj 601# TODO maybe we can take an existing zip/jar? -nichoj
602#
655# FIXME apparently this fails if you give it an empty directories 603# FIXME apparently this fails if you give it an empty directories
656java-pkg_dosrc() { 604java-pkg_dosrc() {
657 debug-print-function ${FUNCNAME} $* 605 debug-print-function ${FUNCNAME} $*
658 606
659 [ ${#} -lt 1 ] && die "At least one argument needed" 607 [ ${#} -lt 1 ] && die "At least one argument needed"
691 639
692 JAVA_SOURCES="${JAVA_PKG_SOURCESPATH}/${zip_name}" 640 JAVA_SOURCES="${JAVA_PKG_SOURCESPATH}/${zip_name}"
693 java-pkg_do_write_ 641 java-pkg_do_write_
694} 642}
695 643
696# ------------------------------------------------------------------------------ 644# @FUNCTION: java-pkg_dolauncher
697# @ebuild-function java-pkg_dolauncher 645# @USAGE: <filename> [options]
698# 646# @DESCRIPTION:
699# Make a wrapper script to lauch/start this package 647# Make a wrapper script to lauch/start this package
700# If necessary, the wrapper will switch to the appropriate VM. 648# If necessary, the wrapper will switch to the appropriate VM.
701# 649#
702# Can be called without parameters if the package installs only one jar 650# Can be called without parameters if the package installs only one jar
703# that has the Main-class attribute set. The wrapper will be named ${PN}. 651# that has the Main-class attribute set. The wrapper will be named ${PN}.
704# 652#
653# @CODE
654# Parameters:
705# @param $1 - filename of launcher to create 655# $1 - filename of launcher to create
706# @param $2 - options, as follows: 656# $2 - options, as follows:
707# --main the.main.class.too.start 657# --main the.main.class.to.start
708# --jar /the/jar/too/launch.jar or just <name>.jar 658# --jar /the/jar/too/launch.jar or just <name>.jar
709# --java_args 'Extra arguments to pass to java' 659# --java_args 'Extra arguments to pass to java'
710# --pkg_args 'Extra arguments to pass to the package' 660# --pkg_args 'Extra arguments to pass to the package'
711# --pwd Directory the launcher changes to before executing java 661# --pwd Directory the launcher changes to before executing java
712# -into Directory to install the launcher to, instead of /usr/bin 662# -into Directory to install the launcher to, instead of /usr/bin
713# -pre Prepend contents of this file to the launcher 663# -pre Prepend contents of this file to the launcher
714# ------------------------------------------------------------------------------ 664# @CODE
715java-pkg_dolauncher() { 665java-pkg_dolauncher() {
716 debug-print-function ${FUNCNAME} $* 666 debug-print-function ${FUNCNAME} $*
717 667
718 java-pkg_check-phase install 668 java-pkg_check-phase install
719 java-pkg_init_paths_ 669 java-pkg_init_paths_
780 else 730 else
781 dobin "${target}" 731 dobin "${target}"
782 fi 732 fi
783} 733}
784 734
785# ------------------------------------------------------------------------------ 735# @FUNCTION: java-pkg_dowar
736# @DESCRIPTION:
786# Install war files. 737# Install war files.
787# TODO document 738# TODO document
788# ------------------------------------------------------------------------------
789java-pkg_dowar() { 739java-pkg_dowar() {
790 debug-print-function ${FUNCNAME} $* 740 debug-print-function ${FUNCNAME} $*
791 741
792 # Check for arguments 742 # Check for arguments
793 [[ ${#} -lt 1 ]] && die "At least one argument needed" 743 [[ ${#} -lt 1 ]] && die "At least one argument needed"
817 INSDESTTREE=${JAVA_PKG_WARDEST} \ 767 INSDESTTREE=${JAVA_PKG_WARDEST} \
818 doins ${warpath} 768 doins ${warpath}
819 done 769 done
820} 770}
821 771
822# ------------------------------------------------------------------------------ 772# @FUNCTION: java-pkg_recordjavadoc
823# @internal-function java-pkg_recordjavadoc 773# @INTERNAL
774# @DESCRIPTION:
824# Scan for JavaDocs, and record their existence in the package.env file 775# Scan for JavaDocs, and record their existence in the package.env file
825# 776
826# TODO make sure this in the proper section 777# TODO make sure this in the proper section
827# ------------------------------------------------------------------------------
828java-pkg_recordjavadoc() 778java-pkg_recordjavadoc()
829{ 779{
830 debug-print-function ${FUNCNAME} $* 780 debug-print-function ${FUNCNAME} $*
831 # the find statement is important 781 # the find statement is important
832 # as some packages include multiple trees of javadoc 782 # as some packages include multiple trees of javadoc
839 else 789 else
840 debug-print "No javadocs found" 790 debug-print "No javadocs found"
841 fi 791 fi
842} 792}
843 793
844# ------------------------------------------------------------------------------
845# @section-end install
846# ------------------------------------------------------------------------------
847 794
848# ------------------------------------------------------------------------------ 795# @FUNCTION: java-pkg_jar-from
849# @begin-section query 796# @USAGE: [--build-only] [--with-dependencies] [--virtual] [--into dir] <package> [<package.jar>] [<destination.jar>]
850# Use these to build the classpath for building a package. 797# @DESCRIPTION:
851# ------------------------------------------------------------------------------
852
853# ------------------------------------------------------------------------------
854# @ebuild-function java-pkg_jar-from
855#
856# Makes a symlink to a jar from a certain package 798# Makes a symlink to a jar from a certain package
857# A lot of java packages include dependencies in a lib/ directory 799# A lot of java packages include dependencies in a lib/ directory
858# You can use this function to replace these bundled dependencies. 800# You can use this function to replace these bundled dependencies.
859# The dependency is recorded into package.env DEPEND line, unless "--build-only" 801# The dependency is recorded into package.env DEPEND line, unless "--build-only"
860# is passed as the very first argument, for jars that have to be present only 802# is passed as the very first argument, for jars that have to be present only
861# at build time and are not needed on runtime (junit testing etc). 803# at build time and are not needed on runtime (junit testing etc).
862# 804#
805# @CODE
863# Example: get all jars from xerces slot 2 806# Example: get all jars from xerces slot 2
864# java-pkg_jar-from xerces-2 807# java-pkg_jar-from xerces-2
808#
865# Example: get a specific jar from xerces slot 2 809# Example: get a specific jar from xerces slot 2
866# java-pkg_jar-from xerces-2 xml-apis.jar 810# java-pkg_jar-from xerces-2 xml-apis.jar
811#
867# Example: get a specific jar from xerces slot 2, and name it diffrently 812# Example: get a specific jar from xerces slot 2, and name it diffrently
868# java-pkg_jar-from xerces-2 xml-apis.jar xml.jar 813# java-pkg_jar-from xerces-2 xml-apis.jar xml.jar
814#
869# Example: get junit.jar which is needed only for building 815# Example: get junit.jar which is needed only for building
870# java-pkg_jar-from --build-only junit junit.jar 816# java-pkg_jar-from --build-only junit junit.jar
817# @CODE
871# 818#
872# @param $opt 819# @CODE
820# Parameters
873# --build-only - makes the jar(s) not added into package.env DEPEND line. 821# --build-only - makes the jar(s) not added into package.env DEPEND line.
874# (assumed automatically when called inside src_test) 822# (assumed automatically when called inside src_test)
875# --with-dependencies - get jars also from requested package's dependencies 823# --with-dependencies - get jars also from requested package's dependencies
876# transitively. 824# transitively.
877# --virtual - Packages passed to this function are to be handled as virtuals 825# --virtual - Packages passed to this function are to be handled as virtuals
878# and will not have individual jar dependencies recorded. 826# and will not have individual jar dependencies recorded.
879# --into $dir - symlink jar(s) into $dir (must exist) instead of . 827# --into $dir - symlink jar(s) into $dir (must exist) instead of .
880# @param $1 - Package to get jars from, or comma-separated list of packages in 828# $1 - Package to get jars from, or comma-separated list of packages in
881# case other parameters are not used. 829# case other parameters are not used.
882# @param $2 - jar from package. If not specified, all jars will be used. 830# $2 - jar from package. If not specified, all jars will be used.
883# @param $3 - When a single jar is specified, destination filename of the 831# $3 - When a single jar is specified, destination filename of the
884# symlink. Defaults to the name of the jar. 832# symlink. Defaults to the name of the jar.
885# ------------------------------------------------------------------------------ 833# @CODE
834
886# TODO could probably be cleaned up a little 835# TODO could probably be cleaned up a little
887java-pkg_jar-from() { 836java-pkg_jar-from() {
888 debug-print-function ${FUNCNAME} $* 837 debug-print-function ${FUNCNAME} $*
889 838
890 local build_only="" 839 local build_only=""
995 else 944 else
996 die "Failed to find ${target_jar:-jar} in ${target_pkg}" 945 die "Failed to find ${target_jar:-jar} in ${target_pkg}"
997 fi 946 fi
998} 947}
999 948
1000# ------------------------------------------------------------------------------ 949# @FUNCTION: java-pkg_jarfrom
1001# @ebuild-function java-pkg_jarfrom 950# @DESCRIPTION:
1002#
1003# See java-pkg_jar-from 951# See java-pkg_jar-from
1004# ------------------------------------------------------------------------------
1005java-pkg_jarfrom() { 952java-pkg_jarfrom() {
1006 java-pkg_jar-from "$@" 953 java-pkg_jar-from "$@"
1007} 954}
1008 955
1009# ------------------------------------------------------------------------------ 956# @FUNCTION: java-pkg_getjars
1010# @ebuild-function java-pkg_getjars 957# @USAGE: [--build-only] [--with-dependencies] <package1>[,<package2>...]
1011# 958# @DESCRIPTION:
1012# Get the classpath provided by any number of packages 959# Get the classpath provided by any number of packages
1013# Among other things, this can be passed to 'javac -classpath' or 'ant -lib'. 960# Among other things, this can be passed to 'javac -classpath' or 'ant -lib'.
1014# The providing packages are recorded as dependencies into package.env DEPEND 961# The providing packages are recorded as dependencies into package.env DEPEND
1015# line, unless "--build-only" is passed as the very first argument, for jars 962# line, unless "--build-only" is passed as the very first argument, for jars
1016# that have to be present only at build time and are not needed on runtime 963# that have to be present only at build time and are not needed on runtime
1017# (junit testing etc). 964# (junit testing etc).
1018# 965#
966# @CODE
1019# Example: Get the classpath for xerces-2 and xalan, 967# Example: Get the classpath for xerces-2 and xalan,
1020# java-pkg_getjars xerces-2,xalan 968# java-pkg_getjars xerces-2,xalan
969#
1021# Example Return: 970# Example Return:
1022# /usr/share/xerces-2/lib/xml-apis.jar:/usr/share/xerces-2/lib/xmlParserAPIs.jar:/usr/share/xalan/lib/xalan.jar 971# /usr/share/xerces-2/lib/xml-apis.jar:/usr/share/xerces-2/lib/xmlParserAPIs.jar:/usr/share/xalan/lib/xalan.jar
1023# 972#
1024# @param $opt 973#
974# Parameters:
1025# --build-only - makes the jar(s) not added into package.env DEPEND line. 975# --build-only - makes the jar(s) not added into package.env DEPEND line.
1026# (assumed automatically when called inside src_test) 976# (assumed automatically when called inside src_test)
1027# --with-dependencies - get jars also from requested package's dependencies 977# --with-dependencies - get jars also from requested package's dependencies
1028# transitively. 978# transitively.
1029# @param $1 - list of packages to get jars from 979# $1 - list of packages to get jars from
1030# (passed to java-config --classpath) 980# (passed to java-config --classpath)
1031# ------------------------------------------------------------------------------ 981# @CODE
1032java-pkg_getjars() { 982java-pkg_getjars() {
1033 debug-print-function ${FUNCNAME} $* 983 debug-print-function ${FUNCNAME} $*
1034 984
1035 local build_only="" 985 local build_only=""
1036 local deep="" 986 local deep=""
1074 done 1024 done
1075 1025
1076 echo "${jars}" 1026 echo "${jars}"
1077} 1027}
1078 1028
1079# ------------------------------------------------------------------------------ 1029# @FUNCTION: java-pkg_getjar
1080# @ebuild-function java-pkg_getjar 1030# @USAGE: [--build-only] [--virtual] <package> <jarfile>
1081# 1031# @DESCRIPTION:
1082# Get the filename of a single jar from a package 1032# Get the complete path of a single jar from a package
1083# The providing package is recorded as runtime dependency into package.env 1033# The providing package is recorded as runtime dependency into package.env
1084# DEPEND line, unless "--build-only" is passed as the very first argument, for 1034# DEPEND line, unless "--build-only" is passed as the very first argument, for
1085# jars that have to be present only at build time and are not needed on runtime 1035# jars that have to be present only at build time and are not needed on runtime
1086# (junit testing etc). 1036# (junit testing etc).
1087# 1037#
1038# @CODE
1088# @example 1039# Example:
1089# java-pkg_getjar xerces-2 xml-apis.jar 1040# java-pkg_getjar xerces-2 xml-apis.jar
1090# @example-return 1041# returns
1091# /usr/share/xerces-2/lib/xml-apis.jar 1042# /usr/share/xerces-2/lib/xml-apis.jar
1092# 1043#
1093# @param $opt 1044# Parameters:
1094# --build-only - makes the jar not added into package.env DEPEND line. 1045# --build-only - makes the jar not added into package.env DEPEND line.
1095# --virtual - Packages passed to this function are to be handled as virtuals 1046# --virtual - Packages passed to this function are to be handled as virtuals
1096# and will not have individual jar dependencies recorded. 1047# and will not have individual jar dependencies recorded.
1097# @param $1 - package to use 1048# $1 - package to use
1098# @param $2 - jar to get 1049# $2 - jar to get
1099# ------------------------------------------------------------------------------ 1050# @CODE
1100java-pkg_getjar() { 1051java-pkg_getjar() {
1101 debug-print-function ${FUNCNAME} $* 1052 debug-print-function ${FUNCNAME} $*
1102 1053
1103 local build_only="" 1054 local build_only=""
1104 local virtual="" 1055 local virtual=""
1167 1118
1168 die "Could not find ${target_jar} in ${pkg}" 1119 die "Could not find ${target_jar} in ${pkg}"
1169 return 1 1120 return 1
1170} 1121}
1171 1122
1172# ------------------------------------------------------------------------------ 1123# @FUNCTION: java-pkg_register-dependency
1173# @ebuild-function java-pkg_register-dependency 1124# @USAGE: <package>[,<package2>...] [<jarfile>]
1174# 1125# @DESCRIPTION:
1175# Registers runtime dependency on a package, list of packages, or a single jar 1126# Registers runtime dependency on a package, list of packages, or a single jar
1176# from a package, into package.env DEPEND line. Can only be called in 1127# from a package, into package.env DEPEND line. Can only be called in
1177# src_install phase. 1128# src_install phase.
1178# Intended for binary packages where you don't need to symlink the jars or get 1129# Intended for binary packages where you don't need to symlink the jars or get
1179# their classpath during build. As such, the dependencies only need to be 1130# their classpath during build. As such, the dependencies only need to be
1180# specified in ebuild's RDEPEND, and should be omitted in DEPEND. 1131# specified in ebuild's RDEPEND, and should be omitted in DEPEND.
1181# 1132#
1133# @CODE
1134# Parameters:
1182# @param $1 - comma-separated list of packages, or a single package 1135# $1 - comma-separated list of packages, or a single package
1183# @param $2 - if param $1 is a single package, optionally specify the jar 1136# $2 - if param $1 is a single package, optionally specify the jar
1184# to depend on 1137# to depend on
1185# 1138#
1139# Examples:
1186# Example: Record the dependency on whole xerces-2 and xalan, 1140# Record the dependency on whole xerces-2 and xalan,
1187# java-pkg_register-dependency xerces-2,xalan 1141# java-pkg_register-dependency xerces-2,xalan
1142#
1188# Example: Record the dependency on ant.jar from ant-core 1143# Record the dependency on ant.jar from ant-core
1189# java-pkg_register-dependency ant-core ant.jar 1144# java-pkg_register-dependency ant-core ant.jar
1145# @CODE
1190# 1146#
1191# Note: Passing both list of packages as the first parameter AND specifying the 1147# Note: Passing both list of packages as the first parameter AND specifying the
1192# jar as the second is not allowed and will cause the function to die. We assume 1148# jar as the second is not allowed and will cause the function to die. We assume
1193# that there's more chance one passes such combination as a mistake, than that 1149# that there's more chance one passes such combination as a mistake, than that
1194# there are more packages providing identically named jar without class 1150# there are more packages providing identically named jar without class
1195# collisions. 1151# collisions.
1196# ------------------------------------------------------------------------------
1197java-pkg_register-dependency() { 1152java-pkg_register-dependency() {
1198 debug-print-function ${FUNCNAME} $* 1153 debug-print-function ${FUNCNAME} $*
1199 1154
1200 java-pkg_check-phase install 1155 java-pkg_check-phase install
1201 1156
1223 fi 1178 fi
1224 1179
1225 java-pkg_do_write_ 1180 java-pkg_do_write_
1226} 1181}
1227 1182
1228# ------------------------------------------------------------------------------
1229# @ebuild-function java-pkg_register-optional-dependency 1183# @FUNCTION: java-pkg_register-optional-dependency
1230# 1184# @USAGE: <package>[,<package2>...] [<jarfile>]
1185# @DESCRIPTION:
1231# Registers optional runtime dependency on a package, list of packages, or a 1186# Registers optional runtime dependency on a package, list of packages, or a
1232# single jar from a package, into package.env OPTIONAL_DEPEND line. Can only be 1187# single jar from a package, into package.env OPTIONAL_DEPEND line. Can only be
1233# called in src_install phase. 1188# called in src_install phase.
1234# Intended for packages that can use other packages when those are in classpath. 1189# Intended for packages that can use other packages when those are in classpath.
1235# Will be put on classpath by launcher if they are installed. Typical case is 1190# Will be put on classpath by launcher if they are installed. Typical case is
1236# JDBC implementations for various databases. It's better than having USE flag 1191# JDBC implementations for various databases. It's better than having USE flag
1237# for each implementation triggering hard dependency. 1192# for each implementation triggering hard dependency.
1238# 1193#
1194# @CODE
1195# Parameters:
1239# @param $1 - comma-separated list of packages, or a single package 1196# $1 - comma-separated list of packages, or a single package
1240# @param $2 - if param $1 is a single package, optionally specify the jar 1197# $2 - if param $1 is a single package, optionally specify the jar to depend on
1241# to depend on
1242# 1198#
1199# Example:
1243# Example: Record the optional dependency on some jdbc providers 1200# Record the optional dependency on some jdbc providers
1244# java-pkg_register-optional-dependency jdbc-jaybird,jtds-1.2,jdbc-mysql 1201# java-pkg_register-optional-dependency jdbc-jaybird,jtds-1.2,jdbc-mysql
1202# @CODE
1245# 1203#
1246# Note: Passing both list of packages as the first parameter AND specifying the 1204# Note: Passing both list of packages as the first parameter AND specifying the
1247# jar as the second is not allowed and will cause the function to die. We assume 1205# jar as the second is not allowed and will cause the function to die. We assume
1248# that there's more chance one passes such combination as a mistake, than that 1206# that there's more chance one passes such combination as a mistake, than that
1249# there are more packages providing identically named jar without class 1207# there are more packages providing identically named jar without class
1250# collisions. 1208# collisions.
1251# ------------------------------------------------------------------------------
1252java-pkg_register-optional-dependency() { 1209java-pkg_register-optional-dependency() {
1253 debug-print-function ${FUNCNAME} $* 1210 debug-print-function ${FUNCNAME} $*
1254 1211
1255 java-pkg_check-phase install 1212 java-pkg_check-phase install
1256 1213
1276 fi 1233 fi
1277 1234
1278 java-pkg_do_write_ 1235 java-pkg_do_write_
1279} 1236}
1280 1237
1281# ------------------------------------------------------------------------------
1282# @ebuild-function java-pkg_register-environment-variable 1238# @FUNCTION: java-pkg_register-environment-variable
1283# 1239# @USAGE: <name> <value>
1240# @DESCRIPTION:
1284# Register an arbitrary environment variable into package.env. The gjl launcher 1241# Register an arbitrary environment variable into package.env. The gjl launcher
1285# for this package or any package depending on this will export it into 1242# for this package or any package depending on this will export it into
1286# environement before executing java command. 1243# environement before executing java command.
1287# Must only be called in src_install phase. 1244# Must only be called in src_install phase.
1288#
1289# @param $1 - variable name
1290# @param $2 - variable value
1291# ------------------------------------------------------------------------------
1292JAVA_PKG_EXTRA_ENV="${T}/java-pkg-extra-env" 1245JAVA_PKG_EXTRA_ENV="${T}/java-pkg-extra-env"
1293JAVA_PKG_EXTRA_ENV_VARS="" 1246JAVA_PKG_EXTRA_ENV_VARS=""
1294java-pkg_register-environment-variable() { 1247java-pkg_register-environment-variable() {
1295 debug-print-function ${FUNCNAME} $* 1248 debug-print-function ${FUNCNAME} $*
1296 1249
1302 JAVA_PKG_EXTRA_ENV_VARS="${JAVA_PKG_EXTRA_ENV_VARS} ${1}" 1255 JAVA_PKG_EXTRA_ENV_VARS="${JAVA_PKG_EXTRA_ENV_VARS} ${1}"
1303 1256
1304 java-pkg_do_write_ 1257 java-pkg_do_write_
1305} 1258}
1306 1259
1307# ------------------------------------------------------------------------------ 1260# @FUNCTION: java-pkg_get-bootclasspath
1308# @ebuild-function java-pkg_get-bootclasspath 1261# @USAGE: <version>
1309# 1262# @DESCRIPTION:
1310# Returns classpath of a given bootclasspath-providing package version. 1263# Returns classpath of a given bootclasspath-providing package version.
1311# 1264#
1312# @param $1 - the version of bootclasspath (e.g. 1.5), 'auto' for bootclasspath 1265# @param $1 - the version of bootclasspath (e.g. 1.5), 'auto' for bootclasspath
1313# of the current JDK 1266# of the current JDK
1314# ------------------------------------------------------------------------------
1315
1316java-pkg_get-bootclasspath() { 1267java-pkg_get-bootclasspath() {
1317 local version="${1}" 1268 local version="${1}"
1318 1269
1319 local bcp 1270 local bcp
1320 case "${version}" in 1271 case "${version}" in
1321 auto) 1272 auto)
1322 bcp="$(java-config -g BOOTCLASSPATH)" 1273 bcp="$(java-config -g BOOTCLASSPATH)"
1323 ;; 1274 ;;
1324 1.5) 1275 1.5)
1325 bcp="$(java-pkg_getjars --build-only gnu-classpath-0.98)" 1276 bcp="$(java-pkg_getjars --build-only gnu-classpath-0.98)"
1368# 1319#
1369# read line 1320# read line
1370# done 1321# done
1371#} 1322#}
1372 1323
1373# ------------------------------------------------------------------------------ 1324# @FUNCTION: java-pkg_find-normal-jars
1374# @section-end query 1325# @USAGE: [<path/to/directory>]
1375# ------------------------------------------------------------------------------ 1326# @DESCRIPTION:
1376
1377# ------------------------------------------------------------------------------
1378# @section-begin helper
1379# @section-summary Helper functions
1380#
1381# Various other functions to use from an ebuild
1382# ------------------------------------------------------------------------------
1383
1384# ------------------------------------------------------------------------------
1385# @ebuild-function java-pkg_find-normal-jars
1386#
1387# Find the files with suffix .jar file in the given directory or $WORKDIR 1327# Find the files with suffix .jar file in the given directory (default: $WORKDIR)
1388#
1389# @param $1 - The directory to search for jar files (default: ${WORKDIR})
1390# ------------------------------------------------------------------------------
1391java-pkg_find-normal-jars() { 1328java-pkg_find-normal-jars() {
1392 local dir=$1 1329 local dir=$1
1393 [[ "${dir}" ]] || dir="${WORKDIR}" 1330 [[ "${dir}" ]] || dir="${WORKDIR}"
1394 local found 1331 local found
1395 for jar in $(find "${dir}" -name "*.jar" -type f); do 1332 for jar in $(find "${dir}" -name "*.jar" -type f); do
1398 done 1335 done
1399 [[ "${found}" ]] 1336 [[ "${found}" ]]
1400 return $? 1337 return $?
1401} 1338}
1402 1339
1403# ------------------------------------------------------------------------------ 1340# @FUNCTION: java-pkg_ensure-no-bundled-jars
1404# @ebuild-function java-pkg_ensure-no-bundled-jars 1341# @DESCRIPTION:
1405#
1406# Try to locate bundled jar files in ${WORKDIR} and die if found. 1342# Try to locate bundled jar files in ${WORKDIR} and die if found.
1407# This function should be called after WORKDIR has been populated with symlink 1343# This function should be called after WORKDIR has been populated with symlink
1408# to system jar files or bundled jars removed. 1344# to system jar files or bundled jars removed.
1409# ------------------------------------------------------------------------------
1410java-pkg_ensure-no-bundled-jars() { 1345java-pkg_ensure-no-bundled-jars() {
1411 debug-print-function ${FUNCNAME} $* 1346 debug-print-function ${FUNCNAME} $*
1412 1347
1413 local bundled_jars=$(java-pkg_find-normal-jars) 1348 local bundled_jars=$(java-pkg_find-normal-jars)
1414 if [[ -n ${bundled_jars} ]]; then 1349 if [[ -n ${bundled_jars} ]]; then
1419 done 1354 done
1420 die "Bundled jars found!" 1355 die "Bundled jars found!"
1421 fi 1356 fi
1422} 1357}
1423 1358
1424# ------------------------------------------------------------------------------
1425# @internal-function java-pkg_ensure-vm-version-sufficient 1359# @FUNCTION: java-pkg_ensure-vm-version-sufficient
1426# 1360# @INTERNAL
1361# @DESCRIPTION:
1427# Checks if we have a sufficient VM and dies if we don't. 1362# Checks if we have a sufficient VM and dies if we don't.
1428#
1429# ------------------------------------------------------------------------------
1430java-pkg_ensure-vm-version-sufficient() { 1363java-pkg_ensure-vm-version-sufficient() {
1431 debug-print-function ${FUNCNAME} $* 1364 debug-print-function ${FUNCNAME} $*
1432 1365
1433 if ! java-pkg_is-vm-version-sufficient; then 1366 if ! java-pkg_is-vm-version-sufficient; then
1434 debug-print "VM is not suffient" 1367 debug-print "VM is not suffient"
1436 einfo "Please use java-config -S to set the correct one" 1369 einfo "Please use java-config -S to set the correct one"
1437 die "Active Java VM cannot build this package" 1370 die "Active Java VM cannot build this package"
1438 fi 1371 fi
1439} 1372}
1440 1373
1441# ------------------------------------------------------------------------------ 1374# @FUNCTION: java-pkg_is-vm-version-sufficient
1442# @internal-function java-pkg_is-vm-version-sufficient 1375# @INTERNAL
1443# 1376# @DESCRIPTION:
1444# @return zero - VM is sufficient 1377# @RETURN: zero - VM is sufficient; non-zero - VM is not sufficient
1445# @return non-zero - VM is not sufficient
1446# ------------------------------------------------------------------------------
1447java-pkg_is-vm-version-sufficient() { 1378java-pkg_is-vm-version-sufficient() {
1448 debug-print-function ${FUNCNAME} $* 1379 debug-print-function ${FUNCNAME} $*
1449 1380
1450 depend-java-query --is-sufficient "${DEPEND}" > /dev/null 1381 depend-java-query --is-sufficient "${DEPEND}" > /dev/null
1451 return $? 1382 return $?
1452} 1383}
1453 1384
1454# ------------------------------------------------------------------------------ 1385# @FUNCTION: java-pkg_ensure-vm-version-eq
1455# @internal-function java-pkg_ensure-vm-version-eq 1386# @INTERNAL
1456# 1387# @DESCRIPTION:
1457# Die if the current VM is not equal to the argument passed. 1388# Die if the current VM is not equal to the argument passed.
1458# 1389#
1459# @param $@ - Desired VM version to ensure 1390# @param $@ - Desired VM version to ensure
1460# ------------------------------------------------------------------------------
1461java-pkg_ensure-vm-version-eq() { 1391java-pkg_ensure-vm-version-eq() {
1462 debug-print-function ${FUNCNAME} $* 1392 debug-print-function ${FUNCNAME} $*
1463 1393
1464 if ! java-pkg_is-vm-version-eq $@ ; then 1394 if ! java-pkg_is-vm-version-eq $@ ; then
1465 debug-print "VM is not suffient" 1395 debug-print "VM is not suffient"
1467 einfo "Please use java-config -S to set the correct one" 1397 einfo "Please use java-config -S to set the correct one"
1468 die "Active Java VM too old" 1398 die "Active Java VM too old"
1469 fi 1399 fi
1470} 1400}
1471 1401
1472# ------------------------------------------------------------------------------ 1402# @FUNCTION: java-pkg_is-vm-version-eq
1473# @internal-function java-pkg_is-vm-version-eq 1403# @USAGE: <version>
1474# 1404# @INTERNAL
1475# @param $@ - VM version to compare current VM to 1405# @RETURN: zero - VM versions are equal; non-zero - VM version are not equal
1476# @return zero - VM versions are equal
1477# @return non-zero - VM version are not equal
1478# ------------------------------------------------------------------------------
1479java-pkg_is-vm-version-eq() { 1406java-pkg_is-vm-version-eq() {
1480 debug-print-function ${FUNCNAME} $* 1407 debug-print-function ${FUNCNAME} $*
1481 1408
1482 local needed_version="$@" 1409 local needed_version="$@"
1483 1410
1500 return 1 1427 return 1
1501 fi 1428 fi
1502 fi 1429 fi
1503} 1430}
1504 1431
1505# ------------------------------------------------------------------------------ 1432# @FUNCTION: java-pkg_ensure-vm-version-ge
1506# @internal-function java-pkg_ensure-vm-version-ge 1433# @INTERNAL
1507# 1434# @DESCRIPTION:
1508# Die if the current VM is not greater than the desired version 1435# Die if the current VM is not greater than the desired version
1509# 1436#
1510# @param $@ - VM version to compare current to 1437# @param $@ - VM version to compare current to
1511# ------------------------------------------------------------------------------
1512java-pkg_ensure-vm-version-ge() { 1438java-pkg_ensure-vm-version-ge() {
1513 debug-print-function ${FUNCNAME} $* 1439 debug-print-function ${FUNCNAME} $*
1514 1440
1515 if ! java-pkg_is-vm-version-ge "$@" ; then 1441 if ! java-pkg_is-vm-version-ge "$@" ; then
1516 debug-print "vm is not suffient" 1442 debug-print "vm is not suffient"
1518 einfo "Please use java-config -S to set the correct one" 1444 einfo "Please use java-config -S to set the correct one"
1519 die "Active Java VM too old" 1445 die "Active Java VM too old"
1520 fi 1446 fi
1521} 1447}
1522 1448
1523# ------------------------------------------------------------------------------ 1449# @FUNCTION: java-pkg_is-vm-version-ge
1524# @internal-function java-pkg_is-vm-version-ge 1450# @INTERNAL
1525# 1451# @DESCRIPTION:
1452# @CODE
1453# Parameters:
1526# @param $@ - VM version to compare current VM to 1454# $@ - VM version to compare current VM to
1455# @CODE
1527# @return zero - current VM version is greater than checked version 1456# @RETURN: zero - current VM version is greater than checked version;
1528# @return non-zero - current VM version is not greater than checked version 1457# non-zero - current VM version is not greater than checked version
1529# ------------------------------------------------------------------------------
1530java-pkg_is-vm-version-ge() { 1458java-pkg_is-vm-version-ge() {
1531 debug-print-function ${FUNCNAME} $* 1459 debug-print-function ${FUNCNAME} $*
1532 1460
1533 local needed_version=$@ 1461 local needed_version=$@
1534 local vm_version=$(java-pkg_get-vm-version) 1462 local vm_version=$(java-pkg_get-vm-version)
1553java-pkg_get-current-vm() { 1481java-pkg_get-current-vm() {
1554 echo ${GENTOO_VM} 1482 echo ${GENTOO_VM}
1555} 1483}
1556 1484
1557java-pkg_current-vm-matches() { 1485java-pkg_current-vm-matches() {
1558 hasq $(java-pkg_get-current-vm) ${@} 1486 has $(java-pkg_get-current-vm) ${@}
1559 return $? 1487 return $?
1560} 1488}
1561 1489
1562# ------------------------------------------------------------------------------ 1490# @FUNCTION: java-pkg_get-source
1563# @ebuild-function java-pkg_get-source 1491# @DESCRIPTION:
1564#
1565# Determines what source version should be used, for passing to -source. 1492# Determines what source version should be used, for passing to -source.
1566# Unless you want to break things you probably shouldn't set _WANT_SOURCE 1493# Unless you want to break things you probably shouldn't set _WANT_SOURCE
1567# 1494#
1568# @return string - Either the lowest possible source, or JAVA_PKG_WANT_SOURCE 1495# @RETURN: string - Either the lowest possible source, or JAVA_PKG_WANT_SOURCE
1569# ------------------------------------------------------------------------------
1570java-pkg_get-source() { 1496java-pkg_get-source() {
1571 echo ${JAVA_PKG_WANT_SOURCE:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")} 1497 echo ${JAVA_PKG_WANT_SOURCE:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1572} 1498}
1573 1499
1574# ------------------------------------------------------------------------------ 1500# @FUNCTION: java-pkg_get-target
1575# @ebuild-function java-pkg_get-target 1501# @DESCRIPTION:
1576#
1577# Determines what target version should be used, for passing to -target. 1502# Determines what target version should be used, for passing to -target.
1578# If you don't care about lower versions, you can set _WANT_TARGET to the 1503# If you don't care about lower versions, you can set _WANT_TARGET to the
1579# version of your JDK. 1504# version of your JDK.
1580# 1505#
1581# @return string - Either the lowest possible target, or JAVA_PKG_WANT_TARGET 1506# @RETURN: string - Either the lowest possible target, or JAVA_PKG_WANT_TARGET
1582# ------------------------------------------------------------------------------
1583java-pkg_get-target() { 1507java-pkg_get-target() {
1584 echo ${JAVA_PKG_WANT_TARGET:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")} 1508 echo ${JAVA_PKG_WANT_TARGET:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1585} 1509}
1586 1510
1511# @FUNCTION: java-pkg_get-javac
1512# @DESCRIPTION:
1513# Returns the compiler executable
1587java-pkg_get-javac() { 1514java-pkg_get-javac() {
1588 debug-print-function ${FUNCNAME} $* 1515 debug-print-function ${FUNCNAME} $*
1589 1516
1590 1517
1591 local compiler="${GENTOO_COMPILER}" 1518 local compiler="${GENTOO_COMPILER}"
1621 fi 1548 fi
1622 fi 1549 fi
1623 echo ${compiler_executable} 1550 echo ${compiler_executable}
1624} 1551}
1625 1552
1626# ------------------------------------------------------------------------------ 1553# @FUNCTION: java-pkg_javac-args
1627# @ebuild-function java-pkg_javac-args 1554# @DESCRIPTION:
1628#
1629# If an ebuild uses javac directly, instead of using ejavac, it should call this 1555# If an ebuild uses javac directly, instead of using ejavac, it should call this
1630# to know what -source/-target to use. 1556# to know what -source/-target to use.
1631# 1557#
1632# @return string - arguments to pass to javac, complete with -target and -source 1558# @RETURN: string - arguments to pass to javac, complete with -target and -source
1633# ------------------------------------------------------------------------------
1634java-pkg_javac-args() { 1559java-pkg_javac-args() {
1635 debug-print-function ${FUNCNAME} $* 1560 debug-print-function ${FUNCNAME} $*
1636 1561
1637 local want_source="$(java-pkg_get-source)" 1562 local want_source="$(java-pkg_get-source)"
1638 local want_target="$(java-pkg_get-target)" 1563 local want_target="$(java-pkg_get-target)"
1654 echo "${target_str}" 1579 echo "${target_str}"
1655 fi 1580 fi
1656 fi 1581 fi
1657} 1582}
1658 1583
1659# TODO document 1584# @FUNCTION: java-pkg_get-jni-cflags
1585# @DESCRIPTION:
1586# Echos the CFLAGS for JNI compilations
1660java-pkg_get-jni-cflags() { 1587java-pkg_get-jni-cflags() {
1661 local flags="-I${JAVA_HOME}/include" 1588 local flags="-I${JAVA_HOME}/include"
1662 1589
1663 local platform="linux" 1590 local platform="linux"
1664 use elibc_FreeBSD && platform="freebsd" 1591 use elibc_FreeBSD && platform="freebsd"
1668 1595
1669 echo ${flags} 1596 echo ${flags}
1670} 1597}
1671 1598
1672java-pkg_ensure-gcj() { 1599java-pkg_ensure-gcj() {
1673 if ! built_with_use sys-devel/gcc gcj ; then 1600 # was enforcing sys-devel/gcc[gcj]
1674 ewarn 1601 die "${FUNCNAME} was removed. Use use-deps available as of EAPI 2 instead. #261562"
1675 ewarn "You must build gcc with the gcj support to build with gcj"
1676 ewarn
1677 ebeep 5
1678 die "No GCJ support found!"
1679 fi
1680} 1602}
1681 1603
1682java-pkg_ensure-test() { 1604java-pkg_ensure-test() {
1683 if hasq test ${FEATURES} && ! hasq -test ${FEATURES} \ 1605 # was enforcing USE=test if FEATURES=test
1684 && hasq test ${IUSE} && ! use test; 1606 die "${FUNCNAME} was removed. Package mangers handle this already. #278965"
1685 then
1686 eerror "You specified FEATURES=test, but USE=test is needed"
1687 eerror "to pull in the additional dependencies for testing"
1688 die "Need USE=test enabled"
1689 fi
1690} 1607}
1691 1608
1692# ------------------------------------------------------------------------------ 1609# @FUNCTION: java-pkg_register-ant-task
1693# @ebuild-function java-pkg_register-ant-task 1610# @USAGE: [--version x.y] [<name>]
1694# 1611# @DESCRIPTION:
1695# Register this package as ant task, so that ant will load it when no specific 1612# Register this package as ant task, so that ant will load it when no specific
1696# ANT_TASKS are specified. Note that even without this registering, all packages 1613# ANT_TASKS are specified. Note that even without this registering, all packages
1697# specified in ANT_TASKS will be loaded. Mostly used by the actual ant tasks 1614# specified in ANT_TASKS will be loaded. Mostly used by the actual ant tasks
1698# packages, but can be also used by other ebuilds that used to symlink their 1615# packages, but can be also used by other ebuilds that used to symlink their
1699# .jar into /usr/share/ant-core/lib to get autoloaded, for backwards 1616# .jar into /usr/share/ant-core/lib to get autoloaded, for backwards
1700# compatibility. 1617# compatibility.
1701# 1618#
1619# @CODE
1620# Parameters
1702# @param --version x.y Register only for ant version x.y (otherwise for any ant 1621# --version x.y Register only for ant version x.y (otherwise for any ant
1703# version). Used by the ant-* packages to prevent loading of mismatched 1622# version). Used by the ant-* packages to prevent loading of mismatched
1704# ant-core ant tasks after core was updated, before the tasks are updated, 1623# ant-core ant tasks after core was updated, before the tasks are updated,
1705# without a need for blockers. 1624# without a need for blockers.
1706# @param $1 Name to register as. Defaults to JAVA_PKG_NAME ($PN[-$SLOT]) 1625# $1 Name to register as. Defaults to JAVA_PKG_NAME ($PN[-$SLOT])
1707# ------------------------------------------------------------------------------ 1626# @CODE
1708java-pkg_register-ant-task() { 1627java-pkg_register-ant-task() {
1709 local TASKS_DIR="tasks" 1628 local TASKS_DIR="tasks"
1710 1629
1711 # check for --version x.y parameters 1630 # check for --version x.y parameters
1712 while [[ -n "${1}" && -n "${2}" ]]; do 1631 while [[ -n "${1}" && -n "${2}" ]]; do
1724 1643
1725 dodir /usr/share/ant/${TASKS_DIR} 1644 dodir /usr/share/ant/${TASKS_DIR}
1726 touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}" 1645 touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}"
1727} 1646}
1728 1647
1729# ------------------------------------------------------------------------------ 1648# @FUNCTION: java-pkg_ant-tasks-depend
1730# @internal-function java-pkg_ant-tasks-depend 1649# @INTERNAL
1731# 1650# @DESCRIPTION:
1732# Translates the WANT_ANT_TASKS variable into valid dependencies. 1651# Translates the WANT_ANT_TASKS variable into valid dependencies.
1733# ------------------------------------------------------------------------------
1734java-pkg_ant-tasks-depend() { 1652java-pkg_ant-tasks-depend() {
1735 debug-print-function ${FUNCNAME} ${WANT_ANT_TASKS} 1653 debug-print-function ${FUNCNAME} ${WANT_ANT_TASKS}
1736 1654
1737 if [[ -n "${WANT_ANT_TASKS}" ]]; then 1655 if [[ -n "${WANT_ANT_TASKS}" ]]; then
1738 local DEP="" 1656 local DEP=""
1752 else 1670 else
1753 return 0 1671 return 0
1754 fi 1672 fi
1755} 1673}
1756 1674
1757# ------------------------------------------------------------------------------ 1675
1758# @ebuild-function ejunit 1676# @FUNCTION: ejunit_
1759# 1677# @INTERNAL
1678# @DESCRIPTION:
1760# Junit wrapper function. Makes it easier to run the tests and checks for 1679# Internal Junit wrapper function. Makes it easier to run the tests and checks for
1761# dev-java/junit in DEPEND. Launches the tests using junit.textui.TestRunner. 1680# dev-java/junit in DEPEND. Launches the tests using junit.textui.TestRunner.
1762# 1681# @CODE
1763# Examples: 1682# Parameters:
1764# ejunit -cp build/classes org.blinkenlights.jid3.test.AllTests 1683# $1 - junit package (junit or junit-4)
1765# ejunit org.blinkenlights.jid3.test.AllTests
1766#
1767# @param $1 - -cp or -classpath 1684# $2 - -cp or -classpath
1768# @param $2 - classpath; junit and recorded dependencies get appended 1685# $3 - classpath; junit and recorded dependencies get appended
1769# @param $@ - the rest of the parameters are passed to java 1686# $@ - the rest of the parameters are passed to java
1770# ------------------------------------------------------------------------------ 1687# @CODE
1771ejunit() { 1688ejunit_() {
1772 debug-print-function ${FUNCNAME} $* 1689 debug-print-function ${FUNCNAME} $*
1773 1690
1774 local pkgs 1691 local pkgs
1775 if [[ -f ${JAVA_PKG_DEPEND_FILE} ]]; then 1692 if [[ -f ${JAVA_PKG_DEPEND_FILE} ]]; then
1776 for atom in $(cat ${JAVA_PKG_DEPEND_FILE} | tr : ' '); do 1693 for atom in $(cat ${JAVA_PKG_DEPEND_FILE} | tr : ' '); do
1777 pkgs=${pkgs},$(echo ${atom} | sed -re "s/^.*@//") 1694 pkgs=${pkgs},$(echo ${atom} | sed -re "s/^.*@//")
1778 done 1695 done
1779 fi 1696 fi
1780 1697
1698 local junit=${1}
1699 shift 1
1700
1781 local cp=$(java-pkg_getjars --with-dependencies junit${pkgs}) 1701 local cp=$(java-pkg_getjars --with-dependencies ${junit}${pkgs})
1782 if [[ ${1} = -cp || ${1} = -classpath ]]; then 1702 if [[ ${1} = -cp || ${1} = -classpath ]]; then
1783 cp="${2}:${cp}" 1703 cp="${2}:${cp}"
1784 shift 2 1704 shift 2
1785 else 1705 else
1786 cp=".:${cp}" 1706 cp=".:${cp}"
1787 fi 1707 fi
1788 1708
1789 local runner=junit.textui.TestRunner 1709 local runner=junit.textui.TestRunner
1710 if [[ "${junit}" == "junit-4" ]] ; then
1711 runner=org.junit.runner.JUnitCore
1712 fi
1790 debug-print "Calling: java -cp \"${cp}\" -Djava.awt.headless=true ${runner} ${@}" 1713 debug-print "Calling: java -cp \"${cp}\" -Djava.awt.headless=true ${runner} ${@}"
1791 java -cp "${cp}" -Djava.awt.headless=true ${runner} "${@}" || die "Running junit failed" 1714 java -cp "${cp}" -Djava.awt.headless=true ${runner} "${@}" || die "Running junit failed"
1792} 1715}
1793 1716
1794# ------------------------------------------------------------------------------ 1717# @FUNCTION: ejunit
1795# @section-end helper 1718# @DESCRIPTION:
1796# ------------------------------------------------------------------------------ 1719# Junit wrapper function. Makes it easier to run the tests and checks for
1797 1720# dev-java/junit in DEPEND. Launches the tests using org.junit.runner.JUnitCore.
1798# ------------------------------------------------------------------------------
1799# @eclass-src_prepare
1800# 1721#
1722# @CODE
1723# Parameters:
1724# $1 - -cp or -classpath
1725# $2 - classpath; junit and recorded dependencies get appended
1726# $@ - the rest of the parameters are passed to java
1727#
1728# Examples:
1729# ejunit -cp build/classes org.blinkenlights.jid3.test.AllTests
1730# ejunit org.blinkenlights.jid3.test.AllTests
1731# ejunit org.blinkenlights.jid3.test.FirstTest org.blinkenlights.jid3.test.SecondTest
1732# @CODE
1733ejunit() {
1734 debug-print-function ${FUNCNAME} $*
1735
1736 ejunit_ "junit" "${@}"
1737}
1738
1739# @FUNCTION: ejunit4
1740# @DESCRIPTION:
1741# Junit4 wrapper function. Makes it easier to run the tests and checks for
1742# dev-java/junit:4 in DEPEND. Launches the tests using junit.textui.TestRunner.
1743#
1744# @CODE
1745# Parameters:
1746# $1 - -cp or -classpath
1747# $2 - classpath; junit and recorded dependencies get appended
1748# $@ - the rest of the parameters are passed to java
1749#
1750# Examples:
1751# ejunit4 -cp build/classes org.blinkenlights.jid3.test.AllTests
1752# ejunit4 org.blinkenlights.jid3.test.AllTests
1753# ejunit4 org.blinkenlights.jid3.test.FirstTest \
1754# org.blinkenlights.jid3.test.SecondTest
1755# @CODE
1756ejunit4() {
1757 debug-print-function ${FUNCNAME} $*
1758
1759 ejunit_ "junit-4" "${@}"
1760}
1761
1762# @FUNCTION: java-utils-2_src_prepare
1763# @DESCRIPTION:
1801# src_prepare Searches for bundled jars 1764# src_prepare Searches for bundled jars
1802# Don't call directly, but via java-pkg-2_src_prepare! 1765# Don't call directly, but via java-pkg-2_src_prepare!
1803# ------------------------------------------------------------------------------
1804
1805java-utils-2_src_prepare() { 1766java-utils-2_src_prepare() {
1806 [[ ${EBUILD_PHASE} == prepare ]] && 1767 [[ ${EBUILD_PHASE} == prepare ]] &&
1807 java-pkg_func-exists java_prepare && java_prepare 1768 java-pkg_func-exists java_prepare && java_prepare
1808 1769
1809 # Remember that eant will call this unless called via Portage 1770 # Remember that eant will call this unless called via Portage
1815 echo "Search done." 1776 echo "Search done."
1816 fi 1777 fi
1817 touch "${T}/java-utils-2_src_prepare-run" 1778 touch "${T}/java-utils-2_src_prepare-run"
1818} 1779}
1819 1780
1820# ------------------------------------------------------------------------------ 1781# @FUNCTION: java-utils-2_pkg_preinst
1821# @eclass-pkg_preinst 1782# @DESCRIPTION:
1822#
1823# pkg_preinst Searches for missing and unneeded dependencies 1783# pkg_preinst Searches for missing and unneeded dependencies
1824# Don't call directly, but via java-pkg-2_pkg_preinst! 1784# Don't call directly, but via java-pkg-2_pkg_preinst!
1825# ------------------------------------------------------------------------------
1826
1827java-utils-2_pkg_preinst() { 1785java-utils-2_pkg_preinst() {
1828 if is-java-strict; then 1786 if is-java-strict; then
1829 if has_version dev-java/java-dep-check; then 1787 if has_version dev-java/java-dep-check; then
1830 [[ -e "${JAVA_PKG_ENV}" ]] || return 1788 [[ -e "${JAVA_PKG_ENV}" ]] || return
1831 local output=$(GENTOO_VM= java-dep-check --image "${D}" "${JAVA_PKG_ENV}") 1789 local output=$(GENTOO_VM= java-dep-check --image "${D}" "${JAVA_PKG_ENV}")
1842 eerror "Install dev-java/java-dep-check for dependency checking" 1800 eerror "Install dev-java/java-dep-check for dependency checking"
1843 fi 1801 fi
1844 fi 1802 fi
1845} 1803}
1846 1804
1847# ------------------------------------------------------------------------------ 1805# @FUNCTION: eant
1848# @section-begin build 1806# @USAGE: <ant_build_target(s)>
1849# @section-summary Build functions 1807# @DESCRIPTION:
1850#
1851# These are some functions for building a package. In particular, it consists of
1852# wrappers for javac and ant.
1853# ------------------------------------------------------------------------------
1854
1855# ------------------------------------------------------------------------------
1856# @ebuild-function eant
1857#
1858# Ant wrapper function. Will use the appropriate compiler, based on user-defined 1808# Ant wrapper function. Will use the appropriate compiler, based on user-defined
1859# compiler. Will also set proper ANT_TASKS from the variable ANT_TASKS, 1809# compiler. Will also set proper ANT_TASKS from the variable ANT_TASKS,
1860# variables: 1810# variables:
1811#
1812# @CODE
1813# Variables:
1861# EANT_GENTOO_CLASSPATH - calls java-pkg_getjars for the value and adds to the 1814# EANT_GENTOO_CLASSPATH - calls java-pkg_getjars for the value and adds to the
1862# gentoo.classpath property. Be sure to call 1815# gentoo.classpath property. Be sure to call java-ant_rewrite-classpath in src_unpack.
1863# java-ant_rewrite-classpath in src_unpack.
1864# EANT_NEEDS_TOOLS - add tools.jar to the gentoo.classpath. Should only be used 1816# EANT_NEEDS_TOOLS - add tools.jar to the gentoo.classpath. Should only be used
1865# for build-time purposes, the dependency is not recorded to 1817# for build-time purposes, the dependency is not recorded to
1866# package.env! 1818# package.env!
1867# JAVA_PKG_NO_BUNDLED_SEARCH - Don't search for bundled jars or class files
1868# *ANT_TASKS - used to determine ANT_TASKS before calling Ant. 1819# ANT_TASKS - used to determine ANT_TASKS before calling Ant.
1869# ------------------------------------------------------------------------------ 1820# @CODE
1870eant() { 1821eant() {
1871 debug-print-function ${FUNCNAME} $* 1822 debug-print-function ${FUNCNAME} $*
1872 1823
1873 if [[ ${EBUILD_PHASE} = compile ]]; then 1824 if [[ ${EBUILD_PHASE} = compile ]]; then
1874 java-ant-2_src_configure 1825 java-ant-2_src_configure
1875 java-utils-2_src_prepare 1826 java-utils-2_src_prepare
1876 fi 1827 fi
1877 1828
1878 if ! hasq java-ant-2 ${INHERITED}; then 1829 if ! has java-ant-2 ${INHERITED}; then
1879 local msg="You should inherit java-ant-2 when using eant" 1830 local msg="You should inherit java-ant-2 when using eant"
1880 java-pkg_announce-qa-violation "${msg}" 1831 java-pkg_announce-qa-violation "${msg}"
1881 fi 1832 fi
1882 1833
1883 local antflags="-Dnoget=true -Dmaven.mode.offline=true -Dbuild.sysclasspath=ignore" 1834 local antflags="-Dnoget=true -Dmaven.mode.offline=true -Dbuild.sysclasspath=ignore"
1958 1909
1959 if [[ ${EBUILD_PHASE} = "test" ]]; then 1910 if [[ ${EBUILD_PHASE} = "test" ]]; then
1960 antflags="${antflags} -DJunit.present=true" 1911 antflags="${antflags} -DJunit.present=true"
1961 [[ ${ANT_TASKS} = *ant-junit* ]] && gcp="${gcp} junit" 1912 [[ ${ANT_TASKS} = *ant-junit* ]] && gcp="${gcp} junit"
1962 getjarsarg="--with-dependencies" 1913 getjarsarg="--with-dependencies"
1914 else
1915 antflags="${antflags} -Dmaven.test.skip=true"
1963 fi 1916 fi
1964 1917
1965 local cp 1918 local cp
1966 1919
1967 for atom in ${gcp}; do 1920 for atom in ${gcp}; do
1981 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}" 1934 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}"
1982 debug-print "Calling ant (GENTOO_VM: ${GENTOO_VM}): ${antflags} ${@}" 1935 debug-print "Calling ant (GENTOO_VM: ${GENTOO_VM}): ${antflags} ${@}"
1983 ant ${antflags} "${@}" || die "eant failed" 1936 ant ${antflags} "${@}" || die "eant failed"
1984} 1937}
1985 1938
1986# ------------------------------------------------------------------------------ 1939# @FUNCTION: ejavac
1987# @ebuild-function ejavac 1940# @USAGE: <javac_arguments>
1988# 1941# @DESCRIPTION:
1989# Javac wrapper function. Will use the appropriate compiler, based on 1942# Javac wrapper function. Will use the appropriate compiler, based on
1990# /etc/java-config/compilers.conf 1943# /etc/java-config/compilers.conf
1991#
1992# @param $@ - Arguments to be passed to the compiler
1993# ------------------------------------------------------------------------------
1994ejavac() { 1944ejavac() {
1995 debug-print-function ${FUNCNAME} $* 1945 debug-print-function ${FUNCNAME} $*
1996 1946
1997 java-pkg_init-compiler_ 1947 java-pkg_init-compiler_
1998 1948
2012 1962
2013 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} ${javac_args} "${@}" 1963 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} ${javac_args} "${@}"
2014 ${compiler_executable} ${javac_args} "${@}" || die "ejavac failed" 1964 ${compiler_executable} ${javac_args} "${@}" || die "ejavac failed"
2015} 1965}
2016 1966
2017# ------------------------------------------------------------------------------ 1967# @FUNCTION: ejavadoc
2018# @ebuild-function java-pkg_filter-compiler 1968# @USAGE: <javadoc_arguments>
2019# 1969# @DESCRIPTION:
1970# javadoc wrapper function. Will set some flags based on the VM version
1971# due to strict javadoc rules in 1.8.
1972ejavadoc() {
1973 debug-print-function ${FUNCNAME} $*
1974
1975 local javadoc_args=""
1976
1977 if java-pkg_is-vm-version-ge "1.8" ; then
1978 javadoc_args="-Xdoclint:none"
1979 fi
1980
1981 javadoc ${javadoc_args} "${@}" || die "ejavadoc failed"
1982}
1983
1984# @FUNCTION: java-pkg_filter-compiler
1985# @USAGE: <compiler(s)_to_filter>
1986# @DESCRIPTION:
2020# Used to prevent the use of some compilers. Should be used in src_compile. 1987# Used to prevent the use of some compilers. Should be used in src_compile.
2021# Basically, it just appends onto JAVA_PKG_FILTER_COMPILER 1988# Basically, it just appends onto JAVA_PKG_FILTER_COMPILER
2022#
2023# @param $@ - compilers to filter
2024# ------------------------------------------------------------------------------
2025java-pkg_filter-compiler() { 1989java-pkg_filter-compiler() {
2026 JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@" 1990 JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@"
2027} 1991}
2028 1992
2029# ------------------------------------------------------------------------------ 1993# @FUNCTION: java-pkg_force-compiler
2030# @ebuild-function java-pkg_force-compiler 1994# @USAGE: <compiler(s)_to_force>
2031# 1995# @DESCRIPTION:
2032# Used to force the use of particular compilers. Should be used in src_compile. 1996# Used to force the use of particular compilers. Should be used in src_compile.
2033# A common use of this would be to force ecj-3.1 to be used on amd64, to avoid 1997# A common use of this would be to force ecj-3.1 to be used on amd64, to avoid
2034# OutOfMemoryErrors that may come up. 1998# OutOfMemoryErrors that may come up.
2035#
2036# @param $@ - compilers to force
2037# ------------------------------------------------------------------------------
2038java-pkg_force-compiler() { 1999java-pkg_force-compiler() {
2039 JAVA_PKG_FORCE_COMPILER="$@" 2000 JAVA_PKG_FORCE_COMPILER="$@"
2040} 2001}
2041 2002
2042# ------------------------------------------------------------------------------ 2003# @FUNCTION: use_doc
2043# @ebuild-function use_doc 2004# @DESCRIPTION:
2044# 2005#
2045# Helper function for getting ant to build javadocs. If the user has USE=doc, 2006# Helper function for getting ant to build javadocs. If the user has USE=doc,
2046# then 'javadoc' or the argument are returned. Otherwise, there is no return. 2007# then 'javadoc' or the argument are returned. Otherwise, there is no return.
2047# 2008#
2048# The output of this should be passed to ant. 2009# The output of this should be passed to ant.
2010# @CODE
2011# Parameters:
2012# $@ - Option value to return. Defaults to 'javadoc'
2049# 2013#
2014# Examples:
2050# Example: build javadocs by calling 'javadoc' target 2015# build javadocs by calling 'javadoc' target
2051# eant $(use_doc) 2016# eant $(use_doc)
2017#
2052# Example: build javadocs by calling 'apidoc' target 2018# build javadocs by calling 'apidoc' target
2053# eant $(use_doc apidoc) 2019# eant $(use_doc apidoc)
2054# 2020# @CODE
2055# @param $@ - Option value to return. Defaults to 'javadoc'
2056# @return string - Name of the target to create javadocs 2021# @RETURN string - Name of the target to create javadocs
2057# ------------------------------------------------------------------------------
2058use_doc() { 2022use_doc() {
2059 use doc && echo ${@:-javadoc} 2023 use doc && echo ${@:-javadoc}
2060} 2024}
2061 2025
2062 2026
2063# ------------------------------------------------------------------------------ 2027# @FUNCTION: java-pkg_init
2064# @section-end build 2028# @INTERNAL
2065# ------------------------------------------------------------------------------ 2029# @DESCRIPTION:
2066
2067# ------------------------------------------------------------------------------
2068# @section-begin internal
2069# @section-summary Internal functions
2070#
2071# Do __NOT__ use any of these from an ebuild! These are only to be used from
2072# within the java eclasses.
2073# ------------------------------------------------------------------------------
2074
2075# -----------------------------------------------------------------------------
2076# @function-internal java-pkg_init
2077#
2078# The purpose of this function, as the name might imply, is to initialize the 2030# The purpose of this function, as the name might imply, is to initialize the
2079# Java environment. It ensures that that there aren't any environment variables 2031# Java environment. It ensures that that there aren't any environment variables
2080# that'll muss things up. It initializes some variables, which are used 2032# that'll muss things up. It initializes some variables, which are used
2081# internally. And most importantly, it'll switch the VM if necessary. 2033# internally. And most importantly, it'll switch the VM if necessary.
2082# 2034#
2083# This shouldn't be used directly. Instead, java-pkg and java-pkg-opt will 2035# This shouldn't be used directly. Instead, java-pkg and java-pkg-opt will
2084# call it during each of the phases of the merge process. 2036# call it during each of the phases of the merge process.
2085#
2086# -----------------------------------------------------------------------------
2087java-pkg_init() { 2037java-pkg_init() {
2088 debug-print-function ${FUNCNAME} $* 2038 debug-print-function ${FUNCNAME} $*
2039
2040 # Don't set up build environment if installing from binary. #206024 #258423
2041 [[ "${MERGE_TYPE}" == "binary" ]] && return
2042 # Also try Portage's nonstandard EMERGE_FROM for old EAPIs, if it doesn't
2043 # work nothing is lost.
2044 has ${EAPI:-0} 0 1 2 3 && [[ "${EMERGE_FROM}" == "binary" ]] && return
2045
2089 unset JAVAC 2046 unset JAVAC
2090 unset JAVA_HOME 2047 unset JAVA_HOME
2091 2048
2092 java-config --help >/dev/null || { 2049 java-config --help >/dev/null || {
2093 eerror "" 2050 eerror ""
2120 2077
2121 if java-pkg_func-exists ant_src_unpack; then 2078 if java-pkg_func-exists ant_src_unpack; then
2122 java-pkg_announce-qa-violation "Using old ant_src_unpack. Should be src_unpack" 2079 java-pkg_announce-qa-violation "Using old ant_src_unpack. Should be src_unpack"
2123 fi 2080 fi
2124 2081
2125 java-pkg_init_paths_
2126 java-pkg_switch-vm 2082 java-pkg_switch-vm
2127 PATH=${JAVA_HOME}/bin:${PATH} 2083 PATH=${JAVA_HOME}/bin:${PATH}
2128 2084
2129 # TODO we will probably want to set JAVAC and JAVACFLAGS 2085 # TODO we will probably want to set JAVAC and JAVACFLAGS
2130 2086
2144 export ANT_TASKS= 2100 export ANT_TASKS=
2145 export ANT_OPTS= 2101 export ANT_OPTS=
2146 export ANT_RESPECT_JAVA_HOME= 2102 export ANT_RESPECT_JAVA_HOME=
2147} 2103}
2148 2104
2149# ------------------------------------------------------------------------------ 2105# @FUNCTION: java-pkg-init-compiler_
2150# @function-internal java-pkg-init-compiler_ 2106# @INTERNAL
2151# 2107# @DESCRIPTION:
2152# This function attempts to figure out what compiler should be used. It does 2108# This function attempts to figure out what compiler should be used. It does
2153# this by reading the file at JAVA_PKG_COMPILERS_CONF, and checking the 2109# this by reading the file at JAVA_PKG_COMPILERS_CONF, and checking the
2154# COMPILERS variable defined there. 2110# COMPILERS variable defined there.
2155# This can be overridden by a list in JAVA_PKG_FORCE_COMPILER 2111# This can be overridden by a list in JAVA_PKG_FORCE_COMPILER
2156# 2112#
2167# If the user doesn't defined anything in JAVA_PKG_COMPILERS_CONF, or no 2123# If the user doesn't defined anything in JAVA_PKG_COMPILERS_CONF, or no
2168# suitable compiler was found there, then the default is to use javac provided 2124# suitable compiler was found there, then the default is to use javac provided
2169# by the current VM. 2125# by the current VM.
2170# 2126#
2171# 2127#
2172# @return name of the compiler to use 2128# @RETURN name of the compiler to use
2173# ------------------------------------------------------------------------------
2174java-pkg_init-compiler_() { 2129java-pkg_init-compiler_() {
2175 debug-print-function ${FUNCNAME} $* 2130 debug-print-function ${FUNCNAME} $*
2176 2131
2177 if [[ -n ${GENTOO_COMPILER} ]]; then 2132 if [[ -n ${GENTOO_COMPILER} ]]; then
2178 debug-print "GENTOO_COMPILER already set" 2133 debug-print "GENTOO_COMPILER already set"
2258 einfo "Using ${GENTOO_COMPILER} for compilation" 2213 einfo "Using ${GENTOO_COMPILER} for compilation"
2259 fi 2214 fi
2260 2215
2261} 2216}
2262 2217
2263# ------------------------------------------------------------------------------ 2218# @FUNCTION: init_paths_
2264# @internal-function init_paths_ 2219# @INTERNAL
2265# 2220# @DESCRIPTION:
2266# Initializes some variables that will be used. These variables are mostly used 2221# Initializes some variables that will be used. These variables are mostly used
2267# to determine where things will eventually get installed. 2222# to determine where things will eventually get installed.
2268# ------------------------------------------------------------------------------
2269java-pkg_init_paths_() { 2223java-pkg_init_paths_() {
2270 debug-print-function ${FUNCNAME} $* 2224 debug-print-function ${FUNCNAME} $*
2271 2225
2272 local pkg_name 2226 local pkg_name
2273 if [[ "$SLOT" == "0" ]] ; then 2227 if [[ "${SLOT%/*}" == "0" ]] ; then
2274 JAVA_PKG_NAME="${PN}" 2228 JAVA_PKG_NAME="${PN}"
2275 else 2229 else
2276 JAVA_PKG_NAME="${PN}-${SLOT}" 2230 JAVA_PKG_NAME="${PN}-${SLOT%/*}"
2277 fi 2231 fi
2278 2232
2279 JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}" 2233 JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}"
2280 JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/" 2234 JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/"
2281 JAVA_PKG_ENV="${D}${JAVA_PKG_SHAREPATH}/package.env" 2235 JAVA_PKG_ENV="${D}${JAVA_PKG_SHAREPATH}/package.env"
2283 JAVA_PKG_VIRTUAL_PROVIDER="${D}/${JAVA_PKG_VIRTUALS_PATH}/${JAVA_PKG_NAME}" 2237 JAVA_PKG_VIRTUAL_PROVIDER="${D}/${JAVA_PKG_VIRTUALS_PATH}/${JAVA_PKG_NAME}"
2284 2238
2285 [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib" 2239 [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib"
2286 [[ -z "${JAVA_PKG_LIBDEST}" ]] && JAVA_PKG_LIBDEST="${DESTTREE}/$(get_libdir)/${JAVA_PKG_NAME}" 2240 [[ -z "${JAVA_PKG_LIBDEST}" ]] && JAVA_PKG_LIBDEST="${DESTTREE}/$(get_libdir)/${JAVA_PKG_NAME}"
2287 [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps" 2241 [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps"
2288
2289 2242
2290 # TODO maybe only print once? 2243 # TODO maybe only print once?
2291 debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}" 2244 debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}"
2292 debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}" 2245 debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}"
2293 debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}" 2246 debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}"
2294 debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}" 2247 debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}"
2295 debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}" 2248 debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}"
2296} 2249}
2297 2250
2298# ------------------------------------------------------------------------------ 2251# @FUNCTION: java-pkg_do_write_
2299# @internal-function java-pkg_do_write_ 2252# @INTERNAL
2300# 2253# @DESCRIPTION:
2301# Writes the package.env out to disk. 2254# Writes the package.env out to disk.
2302# 2255#
2303# ------------------------------------------------------------------------------
2304# TODO change to do-write, to match everything else 2256# TODO change to do-write, to match everything else
2305java-pkg_do_write_() { 2257java-pkg_do_write_() {
2306 debug-print-function ${FUNCNAME} $* 2258 debug-print-function ${FUNCNAME} $*
2307 java-pkg_init_paths_ 2259 java-pkg_init_paths_
2308 # Create directory for package.env 2260 # Create directory for package.env
2320 2272
2321 [[ -n "${JAVA_PKG_CLASSPATH}" ]] && echo "CLASSPATH=\"${JAVA_PKG_CLASSPATH}\"" 2273 [[ -n "${JAVA_PKG_CLASSPATH}" ]] && echo "CLASSPATH=\"${JAVA_PKG_CLASSPATH}\""
2322 [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\"" 2274 [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\""
2323 [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\"" 2275 [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\""
2324 [[ -f "${JAVA_PKG_DEPEND_FILE}" ]] \ 2276 [[ -f "${JAVA_PKG_DEPEND_FILE}" ]] \
2325 && echo "DEPEND=\"$(cat "${JAVA_PKG_DEPEND_FILE}" | uniq | tr '\n' ':')\"" 2277 && echo "DEPEND=\"$(sort -u "${JAVA_PKG_DEPEND_FILE}" | tr '\n' ':')\""
2326 [[ -f "${JAVA_PKG_OPTIONAL_DEPEND_FILE}" ]] \ 2278 [[ -f "${JAVA_PKG_OPTIONAL_DEPEND_FILE}" ]] \
2327 && echo "OPTIONAL_DEPEND=\"$(cat "${JAVA_PKG_OPTIONAL_DEPEND_FILE}" | uniq | tr '\n' ':')\"" 2279 && echo "OPTIONAL_DEPEND=\"$(sort -u "${JAVA_PKG_OPTIONAL_DEPEND_FILE}" | tr '\n' ':')\""
2328 echo "VM=\"$(echo ${RDEPEND} ${DEPEND} | sed -e 's/ /\n/g' | sed -n -e '/virtual\/\(jre\|jdk\)/ { p;q }')\"" # TODO cleanup ! 2280 echo "VM=\"$(echo ${RDEPEND} ${DEPEND} | sed -e 's/ /\n/g' | sed -n -e '/virtual\/\(jre\|jdk\)/ { p;q }')\"" # TODO cleanup !
2329 [[ -f "${JAVA_PKG_BUILD_DEPEND_FILE}" ]] \ 2281 [[ -f "${JAVA_PKG_BUILD_DEPEND_FILE}" ]] \
2330 && echo "BUILD_DEPEND=\"$(cat "${JAVA_PKG_BUILD_DEPEND_FILE}" | uniq | tr '\n' ':')\"" 2282 && echo "BUILD_DEPEND=\"$(sort -u "${JAVA_PKG_BUILD_DEPEND_FILE}" | tr '\n' ':')\""
2331 ) > "${JAVA_PKG_ENV}" 2283 ) > "${JAVA_PKG_ENV}"
2332 2284
2333 # register target/source 2285 # register target/source
2334 local target="$(java-pkg_get-target)" 2286 local target="$(java-pkg_get-target)"
2335 local source="$(java-pkg_get-source)" 2287 local source="$(java-pkg_get-source)"
2363 debug-print "or JAVA_PKG_OPTIONAL_DEPEND_FILE not defined so can't" 2315 debug-print "or JAVA_PKG_OPTIONAL_DEPEND_FILE not defined so can't"
2364 debug-print "write package.env." 2316 debug-print "write package.env."
2365 fi 2317 fi
2366} 2318}
2367 2319
2368# ------------------------------------------------------------------------------ 2320# @FUNCTION: java-pkg_record-jar_
2369# @internal-function java-pkg_record-jar_ 2321# @INTERNAL
2370# 2322# @DESCRIPTION:
2371# Record an (optional) dependency to the package.env 2323# Record an (optional) dependency to the package.env
2324# @CODE
2325# Parameters:
2372# @param --optional - record dependency as optional 2326# --optional - record dependency as optional
2373# @param --build - record dependency as build_only 2327# --build - record dependency as build_only
2374# @param $1 - package to record 2328# $1 - package to record
2375# @param $2 - (optional) jar of package to record 2329# $2 - (optional) jar of package to record
2376# ------------------------------------------------------------------------------ 2330# @CODE
2377JAVA_PKG_DEPEND_FILE="${T}/java-pkg-depend" 2331JAVA_PKG_DEPEND_FILE="${T}/java-pkg-depend"
2378JAVA_PKG_OPTIONAL_DEPEND_FILE="${T}/java-pkg-optional-depend" 2332JAVA_PKG_OPTIONAL_DEPEND_FILE="${T}/java-pkg-optional-depend"
2379JAVA_PKG_BUILD_DEPEND_FILE="${T}/java-pkg-build-depend" 2333JAVA_PKG_BUILD_DEPEND_FILE="${T}/java-pkg-build-depend"
2380 2334
2381java-pkg_record-jar_() { 2335java-pkg_record-jar_() {
2395 fi 2349 fi
2396 2350
2397 echo "${append}" >> "${depend_file}" 2351 echo "${append}" >> "${depend_file}"
2398} 2352}
2399 2353
2400# ------------------------------------------------------------------------------ 2354# @FUNCTION: java-pkg_append_
2401# @internal-function java-pkg_append_ 2355# @INTERNAL
2402# 2356# @DESCRIPTION:
2403# Appends a value to a variable 2357# Appends a value to a variable
2404# 2358#
2405# Example: java-pkg_append_ CLASSPATH foo.jar 2359# @CODE
2360# Parameters:
2406# @param $1 variable name to modify 2361# $1 variable name to modify
2407# @param $2 value to append 2362# $2 value to append
2408# ------------------------------------------------------------------------------ 2363#
2364# Examples:
2365# java-pkg_append_ CLASSPATH foo.jar
2366# @CODE
2409java-pkg_append_() { 2367java-pkg_append_() {
2410 debug-print-function ${FUNCNAME} $* 2368 debug-print-function ${FUNCNAME} $*
2411 2369
2412 local var="${1}" value="${2}" 2370 local var="${1}" value="${2}"
2413 if [[ -z "${!var}" ]] ; then 2371 if [[ -z "${!var}" ]] ; then
2424 [[ -z ${haveit} ]] && export ${var}="${!var}:${value}" 2382 [[ -z ${haveit} ]] && export ${var}="${!var}:${value}"
2425 IFS=${oldIFS} 2383 IFS=${oldIFS}
2426 fi 2384 fi
2427} 2385}
2428 2386
2429# ------------------------------------------------------------------------------ 2387# @FUNCTION: java-pkg_expand_dir_
2430# @internal-function java-pkg_expand_dir_ 2388# @INTERNAL
2431# 2389# @DESCRIPTION:
2432# Gets the full path of the file/directory's parent. 2390# Gets the full path of the file/directory's parent.
2391# @CODE
2392# Parameters:
2433# @param $1 - file/directory to find parent directory for 2393# $1 - file/directory to find parent directory for
2394# @CODE
2434# @return - path to $1's parent directory 2395# @RETURN: path to $1's parent directory
2435# ------------------------------------------------------------------------------
2436java-pkg_expand_dir_() { 2396java-pkg_expand_dir_() {
2437 pushd "$(dirname "${1}")" >/dev/null 2>&1 2397 pushd "$(dirname "${1}")" >/dev/null 2>&1
2438 pwd 2398 pwd
2439 popd >/dev/null 2>&1 2399 popd >/dev/null 2>&1
2440} 2400}
2441 2401
2442# ------------------------------------------------------------------------------ 2402# @FUNCTION: java-pkg_func-exists
2443# @internal-function java-pkg_func-exists 2403# @INTERNAL
2444# 2404# @DESCRIPTION:
2445# Does the indicated function exist? 2405# Does the indicated function exist?
2446# 2406# @RETURN: 0 - function is declared, 1 - function is undeclared
2447# @return 0 - function is declared
2448# @return 1 - function is undeclared
2449# ------------------------------------------------------------------------------
2450java-pkg_func-exists() { 2407java-pkg_func-exists() {
2451 declare -F ${1} > /dev/null 2408 declare -F ${1} > /dev/null
2452} 2409}
2453 2410
2454# ------------------------------------------------------------------------------ 2411# @FUNCTION: java-pkg_setup-vm
2455# @internal-function java-pkg_setup-vm 2412# @INTERNAL
2456# 2413# @DESCRIPTION:
2457# Sets up the environment for a specific VM 2414# Sets up the environment for a specific VM
2458#
2459# ------------------------------------------------------------------------------
2460java-pkg_setup-vm() { 2415java-pkg_setup-vm() {
2461 debug-print-function ${FUNCNAME} $* 2416 debug-print-function ${FUNCNAME} $*
2462
2463 export LANG="C" LC_ALL="C"
2464 2417
2465 local vendor="$(java-pkg_get-vm-vendor)" 2418 local vendor="$(java-pkg_get-vm-vendor)"
2466 if [[ "${vendor}" == "sun" ]] && java-pkg_is-vm-version-ge "1.5" ; then 2419 if [[ "${vendor}" == "sun" ]] && java-pkg_is-vm-version-ge "1.5" ; then
2467 addpredict "/dev/random" 2420 addpredict "/dev/random"
2468 elif [[ "${vendor}" == "ibm" ]]; then 2421 elif [[ "${vendor}" == "ibm" ]]; then
2469 addpredict "/proc/self/maps" 2422 addpredict "/proc/self/maps"
2470 addpredict "/proc/cpuinfo" 2423 addpredict "/proc/cpuinfo"
2424 addpredict "/proc/self/coredump_filter"
2425 elif [[ "${vendor}" == "oracle" ]]; then
2426 addpredict "/dev/random"
2427 addpredict "/proc/self/coredump_filter"
2428 elif [[ "${vendor}" == icedtea* ]] && java-pkg_is-vm-version-ge "1.7" ; then
2429 addpredict "/dev/random"
2430 addpredict "/proc/self/coredump_filter"
2471 elif [[ "${vendor}" == "jrockit" ]]; then 2431 elif [[ "${vendor}" == "jrockit" ]]; then
2472 addpredict "/proc/cpuinfo" 2432 addpredict "/proc/cpuinfo"
2473 fi 2433 fi
2474} 2434}
2475 2435
2476# ------------------------------------------------------------------------------ 2436# @FUNCTION: java-pkg_needs-vm
2477# @internal-function java-pkg_needs-vm 2437# @INTERNAL
2478# 2438# @DESCRIPTION:
2479# Does the current package depend on virtual/jdk? 2439# Does the current package depend on virtual/jdk or does it set
2440# JAVA_PKG_WANT_BUILD_VM?
2480# 2441#
2481# @return 0 - Package depends on virtual/jdk 2442# @RETURN: 0 - Package depends on virtual/jdk; 1 - Package does not depend on virtual/jdk
2482# @return 1 - Package does not depend on virtual/jdk
2483# ------------------------------------------------------------------------------
2484java-pkg_needs-vm() { 2443java-pkg_needs-vm() {
2485 debug-print-function ${FUNCNAME} $* 2444 debug-print-function ${FUNCNAME} $*
2486 2445
2487 if [[ -n "$(echo ${DEPEND} | sed -e '\:virtual/jdk:!d')" ]]; then 2446 if [[ -n "$(echo ${JAVA_PKG_NV_DEPEND:-${DEPEND}} | sed -e '\:virtual/jdk:!d')" ]]; then
2488 return 0 2447 return 0
2489 fi 2448 fi
2490 2449
2450 [[ -n "${JAVA_PKG_WANT_BUILD_VM}" ]] && return 0
2451
2491 return 1 2452 return 1
2492} 2453}
2493 2454
2494# ------------------------------------------------------------------------------ 2455# @FUNCTION: java-pkg_get-current-vm
2495# @internal-function java-pkg_get-current-vm 2456# @INTERNAL
2496#
2497# @return - The current VM being used 2457# @RETURN - The current VM being used
2498# ------------------------------------------------------------------------------
2499java-pkg_get-current-vm() { 2458java-pkg_get-current-vm() {
2500 java-config -f 2459 java-config -f
2501} 2460}
2502 2461
2503# ------------------------------------------------------------------------------ 2462# @FUNCTION: java-pkg_get-vm-vendor
2504# @internal-function java-pkg_get-vm-vendor 2463# @INTERNAL
2505#
2506# @return - The vendor of the current VM 2464# @RETURN - The vendor of the current VM
2507# ------------------------------------------------------------------------------
2508java-pkg_get-vm-vendor() { 2465java-pkg_get-vm-vendor() {
2509 debug-print-function ${FUNCNAME} $* 2466 debug-print-function ${FUNCNAME} $*
2510 2467
2511 local vm="$(java-pkg_get-current-vm)" 2468 local vm="$(java-pkg_get-current-vm)"
2512 vm="${vm/-*/}" 2469 vm="${vm/-*/}"
2513 echo "${vm}" 2470 echo "${vm}"
2514} 2471}
2515 2472
2516# ------------------------------------------------------------------------------ 2473# @FUNCTION: java-pkg_get-vm-version
2517# @internal-function java-pkg_get-vm-version 2474# @INTERNAL
2518#
2519# @return - The version of the current VM 2475# @RETURN - The version of the current VM
2520# ------------------------------------------------------------------------------
2521java-pkg_get-vm-version() { 2476java-pkg_get-vm-version() {
2522 debug-print-function ${FUNCNAME} $* 2477 debug-print-function ${FUNCNAME} $*
2523 2478
2524 java-config -g PROVIDES_VERSION 2479 java-config -g PROVIDES_VERSION
2525} 2480}
2526 2481
2527# ------------------------------------------------------------------------------ 2482# @FUNCTION: java-pkg_build-vm-from-handle
2528# @internal-function java-pkg_switch-vm 2483# @INTERNAL
2484# @DESCRIPTION:
2485# Selects a build vm from a list of vm handles. First checks for the system-vm
2486# beeing usable, then steps through the listed handles till a suitable vm is
2487# found.
2529# 2488#
2489# @RETURN - VM handle of an available JDK
2490java-pkg_build-vm-from-handle() {
2491 debug-print-function ${FUNCNAME} "$*"
2492
2493 local vm
2494 vm=$(java-pkg_get-current-vm 2>/dev/null)
2495 if [[ $? -eq 0 ]]; then
2496 if has ${vm} ${JAVA_PKG_WANT_BUILD_VM}; then
2497 echo ${vm}
2498 return 0
2499 fi
2500 fi
2501
2502 for vm in ${JAVA_PKG_WANT_BUILD_VM}; do
2503 if java-config-2 --select-vm=${vm} 2>/dev/null; then
2504 echo ${vm}
2505 return 0
2506 fi
2507 done
2508
2509 eerror "${FUNCNAME}: No vm found for handles: ${JAVA_PKG_WANT_BUILD_VM}"
2510 return 1
2511}
2512
2513# @FUNCTION: java-pkg_switch-vm
2514# @INTERNAL
2515# @DESCRIPTION:
2530# Switch VM if we're allowed to (controlled by JAVA_PKG_ALLOW_VM_CHANGE), and 2516# Switch VM if we're allowed to (controlled by JAVA_PKG_ALLOW_VM_CHANGE), and
2531# verify that the current VM is sufficient. 2517# verify that the current VM is sufficient.
2532# Setup the environment for the VM being used. 2518# Setup the environment for the VM being used.
2533# ------------------------------------------------------------------------------
2534java-pkg_switch-vm() { 2519java-pkg_switch-vm() {
2535 debug-print-function ${FUNCNAME} $* 2520 debug-print-function ${FUNCNAME} $*
2536 2521
2537 if java-pkg_needs-vm; then 2522 if java-pkg_needs-vm; then
2538 # Use the VM specified by JAVA_PKG_FORCE_VM 2523 # Use the VM specified by JAVA_PKG_FORCE_VM
2540 # If you're forcing the VM, I hope you know what your doing... 2525 # If you're forcing the VM, I hope you know what your doing...
2541 debug-print "JAVA_PKG_FORCE_VM used: ${JAVA_PKG_FORCE_VM}" 2526 debug-print "JAVA_PKG_FORCE_VM used: ${JAVA_PKG_FORCE_VM}"
2542 export GENTOO_VM="${JAVA_PKG_FORCE_VM}" 2527 export GENTOO_VM="${JAVA_PKG_FORCE_VM}"
2543 # if we're allowed to switch the vm... 2528 # if we're allowed to switch the vm...
2544 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then 2529 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then
2545 debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}" 2530 # if there is an explicit list of handles to choose from
2546 GENTOO_VM="$(depend-java-query --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")" 2531 if [[ -n "${JAVA_PKG_WANT_BUILD_VM}" ]]; then
2547 if [[ -z "${GENTOO_VM}" || "${GENTOO_VM}" == "None" ]]; then 2532 debug-print "JAVA_PKG_WANT_BUILD_VM used: ${JAVA_PKG_WANT_BUILD_VM}"
2548 eerror "Unable to determine VM for building from dependencies:" 2533 GENTOO_VM=$(java-pkg_build-vm-from-handle)
2549 echo "NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}" 2534 if [[ $? != 0 ]]; then
2535 eerror "${FUNCNAME}: No VM found for handles: ${JAVA_PKG_WANT_BUILD_VM}"
2550 die "Failed to determine VM for building." 2536 die "${FUNCNAME}: Failed to determine VM for building"
2537 fi
2538 # JAVA_PKG_WANT_SOURCE and JAVA_PKG_WANT_TARGET are required as
2539 # they can't be deduced from handles.
2540 if [[ -z "${JAVA_PKG_WANT_SOURCE}" ]]; then
2541 eerror "JAVA_PKG_WANT_BUILD_VM specified but not JAVA_PKG_WANT_SOURCE"
2542 die "Specify JAVA_PKG_WANT_SOURCE"
2543 fi
2544 if [[ -z "${JAVA_PKG_WANT_TARGET}" ]]; then
2545 eerror "JAVA_PKG_WANT_BUILD_VM specified but not JAVA_PKG_WANT_TARGET"
2546 die "Specify JAVA_PKG_WANT_TARGET"
2547 fi
2548 # otherwise determine a vm from dep string
2551 else 2549 else
2552 export GENTOO_VM 2550 debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
2551 GENTOO_VM="$(depend-java-query --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")"
2552 if [[ -z "${GENTOO_VM}" || "${GENTOO_VM}" == "None" ]]; then
2553 eerror "Unable to determine VM for building from dependencies:"
2554 echo "NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
2555 die "Failed to determine VM for building."
2556 fi
2553 fi 2557 fi
2558 export GENTOO_VM
2554 # otherwise just make sure the current VM is sufficient 2559 # otherwise just make sure the current VM is sufficient
2555 else 2560 else
2556 java-pkg_ensure-vm-version-sufficient 2561 java-pkg_ensure-vm-version-sufficient
2557 fi 2562 fi
2558 debug-print "Using: $(java-config -f)" 2563 debug-print "Using: $(java-config -f)"
2586 else 2591 else
2587 [[ -n "${JAVA_PKG_DEBUG}" ]] && ewarn "!!! This package inherits java-pkg but doesn't depend on a JDK. -bin or broken dependency!!!" 2592 [[ -n "${JAVA_PKG_DEBUG}" ]] && ewarn "!!! This package inherits java-pkg but doesn't depend on a JDK. -bin or broken dependency!!!"
2588 fi 2593 fi
2589} 2594}
2590 2595
2591# ------------------------------------------------------------------------------ 2596# @FUNCTION: java-pkg_die
2592# @internal-function java-pkg_die 2597# @INTERNAL
2593# 2598# @DESCRIPTION:
2594# Enhanced die for Java packages, which displays some information that may be 2599# Enhanced die for Java packages, which displays some information that may be
2595# useful for debugging bugs on bugzilla. 2600# useful for debugging bugs on bugzilla.
2596# ------------------------------------------------------------------------------
2597#register_die_hook java-pkg_die 2601#register_die_hook java-pkg_die
2598if ! hasq java-pkg_die ${EBUILD_DEATH_HOOKS}; then 2602if ! has java-pkg_die ${EBUILD_DEATH_HOOKS}; then
2599 EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die" 2603 EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die"
2600fi 2604fi
2601 2605
2602java-pkg_die() { 2606java-pkg_die() {
2603 echo "!!! When you file a bug report, please include the following information:" >&2 2607 echo "!!! When you file a bug report, please include the following information:" >&2
2604 echo "GENTOO_VM=${GENTOO_VM} CLASSPATH=\"${CLASSPATH}\" JAVA_HOME=\"${JAVA_HOME}\"" >&2 2608 echo "GENTOO_VM=${GENTOO_VM} CLASSPATH=\"${CLASSPATH}\" JAVA_HOME=\"${JAVA_HOME}\"" >&2
2605 echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2 2609 echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2
2606 echo "and of course, the output of emerge --info" >&2 2610 echo "and of course, the output of emerge --info =${P}" >&2
2607} 2611}
2608 2612
2609 2613
2610# TODO document 2614# TODO document
2611# List jars in the source directory, ${S} 2615# List jars in the source directory, ${S}
2618 einfo "Classes" 2622 einfo "Classes"
2619 find "${S}" -type f -name '*.class' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR}," 2623 find "${S}" -type f -name '*.class' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2620 fi 2624 fi
2621} 2625}
2622 2626
2623# ------------------------------------------------------------------------------ 2627# @FUNCTION: java-pkg_verify-classes
2624# @internal-function java-pkg_verify-classes 2628# @INTERNAL
2625# 2629# @DESCRIPTION:
2626# Verify that the classes were compiled for the right source / target. Dies if 2630# Verify that the classes were compiled for the right source / target. Dies if
2627# not. 2631# not.
2632# @CODE
2628# @param $1 (optional) - the file to check, otherwise checks whole ${D} 2633# $1 (optional) - the file to check, otherwise checks whole ${D}
2629# ------------------------------------------------------------------------------ 2634# @CODE
2630java-pkg_verify-classes() { 2635java-pkg_verify-classes() {
2631 #$(find ${D} -type f -name '*.jar' -o -name '*.class') 2636 #$(find ${D} -type f -name '*.jar' -o -name '*.class')
2632 2637
2633 local version_verify="/usr/bin/class-version-verify.py" 2638 local version_verify="/usr/bin/class-version-verify.py"
2634 2639
2662 eerror "See ${log} for more details." 2667 eerror "See ${log} for more details."
2663 die "Incorrect bytecode found" 2668 die "Incorrect bytecode found"
2664 fi 2669 fi
2665} 2670}
2666 2671
2667# ---------------------------------------------------------------------------- 2672# @FUNCTION: java-pkg_ensure-dep
2668# @internal-function java-pkg_ensure-dep 2673# @INTERNAL
2674# @DESCRIPTION:
2669# Check that a package being used in jarfrom, getjars and getjar is contained 2675# Check that a package being used in jarfrom, getjars and getjar is contained
2670# within DEPEND or RDEPEND. 2676# within DEPEND or RDEPEND.
2677# @CODE
2678# Parameters:
2671# @param $1 - empty - check both vars; "runtime" or "build" - check only 2679# $1 - empty - check both vars; "runtime" or "build" - check only
2672# RDEPEND, resp. DEPEND 2680# RDEPEND, resp. DEPEND
2673# @param $2 - Package name and slot. 2681# $2 - Package name and slot.
2674 2682# @CODE
2675java-pkg_ensure-dep() { 2683java-pkg_ensure-dep() {
2676 debug-print-function ${FUNCNAME} $* 2684 debug-print-function ${FUNCNAME} $*
2677 2685
2678 local limit_to="${1}" 2686 local limit_to="${1}"
2679 local target_pkg="${2}" 2687 local target_pkg="${2}"
2680 local dev_error="" 2688 local dev_error=""
2681 2689
2690 # remove the version specification, which may include globbing (* and [123])
2682 local stripped_pkg=$(echo "${target_pkg}" | sed \ 2691 local stripped_pkg=$(echo "${target_pkg}" | sed \
2683 's/-[0-9]*\(\.[0-9]\)*$//') 2692 's/-\([0-9*]*\(\[[0-9]*\]\)*\)*\(\.\([0-9*]*\(\[[0-9]*\]\)*\)*\)*$//')
2684 2693
2685 debug-print "Matching against: ${stripped_pkg}" 2694 debug-print "Matching against: ${stripped_pkg}"
2686 2695
2687 if [[ ${limit_to} != runtime && ! ( "${DEPEND}" =~ "$stripped_pkg" ) ]]; then 2696 if [[ ${limit_to} != runtime && ! ( "${DEPEND}" =~ "$stripped_pkg" ) ]]; then
2688 dev_error="The ebuild is attempting to use ${target_pkg} that is not" 2697 dev_error="The ebuild is attempting to use ${target_pkg} that is not"
2716 fi 2725 fi
2717 fi 2726 fi
2718 fi 2727 fi
2719} 2728}
2720 2729
2721# ------------------------------------------------------------------------------
2722# @section-end internal
2723# ------------------------------------------------------------------------------
2724
2725java-pkg_check-phase() { 2730java-pkg_check-phase() {
2726 local phase=${1} 2731 local phase=${1}
2727 local funcname=${FUNCNAME[1]} 2732 local funcname=${FUNCNAME[1]}
2728 if [[ ${EBUILD_PHASE} != ${phase} ]]; then 2733 if [[ ${EBUILD_PHASE} != ${phase} ]]; then
2729 local msg="${funcname} used outside of src_${phase}" 2734 local msg="${funcname} used outside of src_${phase}"
2738 java-pkg_announce-qa-violation "installing versioned jar '${jar}'" 2743 java-pkg_announce-qa-violation "installing versioned jar '${jar}'"
2739 fi 2744 fi
2740} 2745}
2741 2746
2742java-pkg_check-jikes() { 2747java-pkg_check-jikes() {
2743 if hasq jikes ${IUSE}; then 2748 if has jikes ${IUSE}; then
2744 java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE" 2749 java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE"
2745 fi 2750 fi
2746} 2751}
2747 2752
2748java-pkg_announce-qa-violation() { 2753java-pkg_announce-qa-violation() {
2763 2768
2764is-java-strict() { 2769is-java-strict() {
2765 [[ -n ${JAVA_PKG_STRICT} ]] 2770 [[ -n ${JAVA_PKG_STRICT} ]]
2766 return $? 2771 return $?
2767} 2772}
2768
2769
2770# ------------------------------------------------------------------------------
2771# @eclass-end
2772# ------------------------------------------------------------------------------

Legend:
Removed from v.1.132  
changed lines
  Added in v.1.157

  ViewVC Help
Powered by ViewVC 1.1.20