/[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.150 Revision 1.157
4# Copyright (c) 2004, Karl Trygve Kalleberg <karltk@gentoo.org> 4# Copyright (c) 2004, Karl Trygve Kalleberg <karltk@gentoo.org>
5# Copyright (c) 2004-2011, 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.150 2012/03/13 10:05:46 sera 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# -----------------------------------------------------------------------------
66has "${EAPI}" 0 1 && JAVA_PKG_PORTAGE_DEP=">=sys-apps/portage-2.1.2.7" 38has "${EAPI}" 0 1 && JAVA_PKG_PORTAGE_DEP=">=sys-apps/portage-2.1.2.7"
67 39
68# ----------------------------------------------------------------------------- 40# @VARIABLE: JAVA_PKG_E_DEPEND
69# @variable-internal JAVA_PKG_E_DEPEND 41# @INTERNAL
70# 42# @DESCRIPTION:
71# This is a convience variable to be used from the other java eclasses. This is 43# This is a convience variable to be used from the other java eclasses. This is
72# the version of java-config we want to use. Usually the latest stable version 44# the version of java-config we want to use. Usually the latest stable version
73# so that ebuilds can use new features without depending on specific versions. 45# so that ebuilds can use new features without depending on specific versions.
74# -----------------------------------------------------------------------------
75JAVA_PKG_E_DEPEND=">=dev-java/java-config-2.1.9-r1 ${JAVA_PKG_PORTAGE_DEP}" 46JAVA_PKG_E_DEPEND=">=dev-java/java-config-2.1.9-r1 ${JAVA_PKG_PORTAGE_DEP}"
76has source ${JAVA_PKG_IUSE} && JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} source? ( app-arch/zip )" 47has source ${JAVA_PKG_IUSE} && JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} source? ( app-arch/zip )"
77 48
78# ----------------------------------------------------------------------------- 49# @ECLASS-VARIABLE: JAVA_PKG_WANT_BOOTCLASSPATH
79# @variable-preinherit JAVA_PKG_WANT_BOOTCLASSPATH 50# @DEFAULT_UNSET
80# 51# @DESCRIPTION:
81# The version of bootclasspath the package needs to work. Translates to a proper 52# The version of bootclasspath the package needs to work. Translates to a proper
82# dependency. The bootclasspath has to be obtained by java-ant_rewrite-bootclasspath 53# dependency. The bootclasspath can then be obtained by java-ant_rewrite-bootclasspath
83# -----------------------------------------------------------------------------
84
85if [[ -n "${JAVA_PKG_WANT_BOOTCLASSPATH}" ]]; then 54if [[ -n "${JAVA_PKG_WANT_BOOTCLASSPATH}" ]]; then
86 if [[ "${JAVA_PKG_WANT_BOOTCLASSPATH}" == "1.5" ]]; then 55 if [[ "${JAVA_PKG_WANT_BOOTCLASSPATH}" == "1.5" ]]; then
87 JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} >=dev-java/gnu-classpath-0.98-r1:0.98" 56 JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} >=dev-java/gnu-classpath-0.98-r1:0.98"
88 else 57 else
89 eerror "Unknown value of JAVA_PKG_WANT_BOOTCLASSPATH" 58 eerror "Unknown value of JAVA_PKG_WANT_BOOTCLASSPATH"
90 # since die in global scope doesn't work, this will make repoman fail 59 # since die in global scope doesn't work, this will make repoman fail
91 JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} BAD_JAVA_PKG_WANT_BOOTCLASSPATH" 60 JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} BAD_JAVA_PKG_WANT_BOOTCLASSPATH"
92 fi 61 fi
93fi 62fi
94 63
95# ----------------------------------------------------------------------------- 64# @ECLASS-VARIABLE: JAVA_PKG_ALLOW_VM_CHANGE
96# @variable-external JAVA_PKG_ALLOW_VM_CHANGE 65# @DESCRIPTION:
97# @variable-default yes
98#
99# Allow this eclass to change the active VM? 66# Allow this eclass to change the active VM?
100# If your system VM isn't sufficient for the package, the build will fail. 67# If your system VM isn't sufficient for the package, the build will fail
101# @note This is useful for testing specific VMs. 68# instead of trying to switch to another VM.
102# ----------------------------------------------------------------------------- 69#
70# Overriding the default can be useful for testing specific VMs locally, but
71# should not be used in the final ebuild.
103JAVA_PKG_ALLOW_VM_CHANGE=${JAVA_PKG_ALLOW_VM_CHANGE:="yes"} 72JAVA_PKG_ALLOW_VM_CHANGE=${JAVA_PKG_ALLOW_VM_CHANGE:="yes"}
104 73
105# ----------------------------------------------------------------------------- 74# @ECLASS-VARIABLE: JAVA_PKG_FORCE_VM
106# @variable-external JAVA_PKG_FORCE_VM 75# @DEFAULT_UNSET
107# 76# @DESCRIPTION:
108# Explicitly set a particular VM to use. If its not valid, it'll fall back to 77# Explicitly set a particular VM to use. If its not valid, it'll fall back to
109# whatever /etc/java-config-2/build/jdk.conf would elect to use. 78# whatever /etc/java-config-2/build/jdk.conf would elect to use.
110# 79#
111# Should only be used for testing and debugging. 80# Should only be used for testing and debugging.
112# 81#
113# @example Use sun-jdk-1.5 to emerge foo 82# Example: use sun-jdk-1.5 to emerge foo:
83# @CODE
114# JAVA_PKG_FORCE_VM=sun-jdk-1.5 emerge foo 84# JAVA_PKG_FORCE_VM=sun-jdk-1.5 emerge foo
115# 85# @CODE
116# -----------------------------------------------------------------------------
117 86
118# ----------------------------------------------------------------------------- 87# @ECLASS-VARIABLE: JAVA_PKG_WANT_BUILD_VM
119# @variable-external JAVA_PKG_WANT_BUILD_VM 88# @DEFAULT_UNSET
120# 89# @DESCRIPTION:
121# A list of VM handles to choose a build VM from. If the list contains the 90# A list of VM handles to choose a build VM from. If the list contains the
122# currently active VM use that one, otherwise step through the list till a 91# currently active VM use that one, otherwise step through the list till a
123# usable/installed VM is found. 92# usable/installed VM is found.
124# 93#
125# This allows to use an explicit list of JDKs in DEPEND instead of a virtual. 94# This allows to use an explicit list of JDKs in DEPEND instead of a virtual.
126# Users of this variable must make sure at least one of the listed handles is 95# Users of this variable must make sure at least one of the listed handles is
127# covered by DEPEND. 96# covered by DEPEND.
128# Requires JAVA_PKG_WANT_SOURCE and JAVA_PKG_WANT_TARGET to be set as well. 97# Requires JAVA_PKG_WANT_SOURCE and JAVA_PKG_WANT_TARGET to be set as well.
129# -----------------------------------------------------------------------------
130 98
131# ----------------------------------------------------------------------------- 99# @ECLASS-VARIABLE: JAVA_PKG_WANT_SOURCE
132# @variable-external JAVA_PKG_WANT_SOURCE 100# @DEFAULT_UNSET
133# 101# @DESCRIPTION:
134# Specify a specific VM version to compile for to use for -source. 102# Specify a non-standard Java source version for compilation (via javac -source
135# Normally this is determined from DEPEND. 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.
136# See java-pkg_get-source function below. 105# See java-pkg_get-source function below.
137# 106#
138# Should only be used for testing and debugging. 107# Should generally only be used for testing and debugging.
139# 108#
140# @seealso java-pkg_get-source
141#
142# @example Use 1.4 source to emerge baz 109# Use 1.4 source to emerge baz
110# @CODE
143# JAVA_PKG_WANT_SOURCE=1.4 emerge baz 111# JAVA_PKG_WANT_SOURCE=1.4 emerge baz
144# ----------------------------------------------------------------------------- 112# @CODE
145 113
146# ----------------------------------------------------------------------------- 114# @ECLASS-VARIABLE: JAVA_PKG_WANT_TARGET
147# @variable-external JAVA_PKG_WANT_TARGET 115# @DEFAULT_UNSET
148# 116# @DESCRIPTION:
149# 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.
150# See java-pkg_get-target function below. 120# See java-pkg_get-target function below.
151# 121#
152# Should only be used for testing and debugging. 122# Should generallyonly be used for testing and debugging.
153# 123#
154# @seealso java-pkg_get-target
155#
156# @example emerge bar to be compatible with 1.3 124# emerge bar to be compatible with 1.3
125# @CODE
157# JAVA_PKG_WANT_TARGET=1.3 emerge bar 126# JAVA_PKG_WANT_TARGET=1.3 emerge bar
158# ----------------------------------------------------------------------------- 127# @CODE
159 128
160# ----------------------------------------------------------------------------- 129# @VARIABLE: JAVA_PKG_COMPILER_DIR
161# @variable-internal JAVA_PKG_COMPILER_DIR 130# @INTERNAL
162# @default /usr/share/java-config-2/compiler 131# @DESCRIPTION:
163#
164# Directory where compiler settings are saved, without trailing slash. 132# Directory where compiler settings are saved, without trailing slash.
165# Probably shouldn't touch this variable. 133# You probably shouldn't touch this variable except local testing.
166# -----------------------------------------------------------------------------
167JAVA_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"}
168 135
169 136# @VARIABLE: JAVA_PKG_COMPILERS_CONF
170# ----------------------------------------------------------------------------- 137# @INTERNAL
171# @variable-internal JAVA_PKG_COMPILERS_CONF 138# @DESCRIPTION:
172# @variable-default /etc/java-config-2/build/compilers.conf
173#
174# Path to file containing information about which compiler to use. 139# Path to file containing information about which compiler to use.
175# Can be overloaded, but it should be overloaded for testing. 140# Can be overloaded, but it should be overloaded only for local testing.
176# -----------------------------------------------------------------------------
177JAVA_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"}
178 142
179# ----------------------------------------------------------------------------- 143# @ECLASS-VARIABLE: JAVA_PKG_FORCE_COMPILER
180# @variable-external JAVA_PKG_FORCE_COMPILER 144# @INTERNAL
181# 145# @DEFAULT_UNSET
146# @DESCRIPTION:
182# 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
183# JAVA_PKG_COMPILERS_CONF. 148# JAVA_PKG_COMPILERS_CONF.
184# 149#
185# @note This should only be used internally or for testing. 150# Useful for local testing.
151#
186# @example Use jikes and javac, in that order 152# Use jikes and javac, in that order
153# @CODE
187# JAVA_PKG_FORCE_COMPILER="jikes javac" 154# JAVA_PKG_FORCE_COMPILER="jikes javac"
188# ----------------------------------------------------------------------------- 155# @CODE
189 156
190# ----------------------------------------------------------------------------- 157# @ECLASS-VARIABLE: JAVA_PKG_FORCE_ANT_TASKS
191# @variable-external JAVA_PKG_FORCE_ANT_TASKS 158# @DEFAULT_UNSET
192# 159# @DESCRIPTION:
193# 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
194# 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
195# 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
196# eant() call, not the dependencies specified in WANT_ANT_TASKS. 163# eant() call, not the dependencies specified in WANT_ANT_TASKS.
197# 164#
165# @CODE
198# @example JAVA_PKG_FORCE_ANT_TASKS="ant-junit ant-trax" \ 166# JAVA_PKG_FORCE_ANT_TASKS="ant-junit ant-trax" \
199# ebuild foo.ebuild compile 167# ebuild foo.ebuild compile
200# 168# @CODE
201# @seealso WANT_ANT_TASKS
202# -----------------------------------------------------------------------------
203 169
204# TODO document me 170# TODO document me
205JAVA_PKG_QA_VIOLATIONS=0 171JAVA_PKG_QA_VIOLATIONS=0
206 172
207# ----------------------------------------------------------------------------- 173# @FUNCTION: java-pkg_doexamples
208# @section-end variables 174# @USAGE: [--subdir <subdir>] <file1/dir1> [<file2> ...]
209# ----------------------------------------------------------------------------- 175# @DESCRIPTION:
210
211
212# -----------------------------------------------------------------------------
213# @section-begin install
214# @section-summary Install functions
215#
216# These are used to install Java-related things, such as jars, Javadocs, JNI
217# libraries, etc.
218# -----------------------------------------------------------------------------
219
220# -----------------------------------------------------------------------------
221# @ebuild-function java-pkg_doexamples
222#
223# Installs given arguments to /usr/share/doc/${PF}/examples 176# Installs given arguments to /usr/share/doc/${PF}/examples
224# 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
225# everything in that directory to the examples directory. 178# everything in that directory to the examples directory.
226# 179#
180# @CODE
181# Parameters:
182# --subdir - If the examples need a certain directory structure
183# $* - list of files to install
184#
227# @example 185# Examples:
228# java-pkg_doexamples demo 186# java-pkg_doexamples demo
229# java-pkg_doexamples demo/* examples/* 187# java-pkg_doexamples demo/* examples/*
230# 188# @CODE
231# @param --subdir - If the examples need a certain directory structure
232# @param $* - list of files to install
233# ------------------------------------------------------------------------------
234java-pkg_doexamples() { 189java-pkg_doexamples() {
235 debug-print-function ${FUNCNAME} $* 190 debug-print-function ${FUNCNAME} $*
236 191
237 [[ ${#} -lt 1 ]] && die "At least one argument needed" 192 [[ ${#} -lt 1 ]] && die "At least one argument needed"
238 193
239 java-pkg_check-phase install 194 java-pkg_check-phase install
195 java-pkg_init_paths_
240 196
241 local dest=/usr/share/doc/${PF}/examples 197 local dest=/usr/share/doc/${PF}/examples
242 if [[ ${1} == --subdir ]]; then 198 if [[ ${1} == --subdir ]]; then
243 local dest=${dest}/${2} 199 local dest=${dest}/${2}
244 dodir ${dest} 200 dodir ${dest}
259 215
260 # Let's make a symlink to the directory we have everything else under 216 # Let's make a symlink to the directory we have everything else under
261 dosym "${dest}" "${JAVA_PKG_SHAREPATH}/examples" || die 217 dosym "${dest}" "${JAVA_PKG_SHAREPATH}/examples" || die
262} 218}
263 219
264# ----------------------------------------------------------------------------- 220# @FUNCTION: java-pkg_dojar
265# @ebuild-function java-pkg_dojar 221# @USAGE: <jar1> [<jar2> ...]
266# 222# @DESCRIPTION:
267# Installs any number of jars. 223# Installs any number of jars.
268# 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.
269# You can use java-pkg_jarinto to change this path. 225# You can use java-pkg_jarinto to change this path.
270# 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.
271# Instead, use java-pkg_newjar defined below. 227# Instead, use java-pkg_newjar defined below.
272# 228#
273# @example 229# @CODE
274# java-pkg_dojar dist/${PN}.jar dist/${PN}-core.jar 230# java-pkg_dojar dist/${PN}.jar dist/${PN}-core.jar
231# @CODE
275# 232#
276# @param $* - list of jars to install 233# @param $* - list of jars to install
277# ------------------------------------------------------------------------------
278java-pkg_dojar() { 234java-pkg_dojar() {
279 debug-print-function ${FUNCNAME} $* 235 debug-print-function ${FUNCNAME} $*
280 236
281 [[ ${#} -lt 1 ]] && die "At least one argument needed" 237 [[ ${#} -lt 1 ]] && die "At least one argument needed"
282 238
324 done 280 done
325 281
326 java-pkg_do_write_ 282 java-pkg_do_write_
327} 283}
328 284
329# ------------------------------------------------------------------------------ 285# @FUNCTION: depend-java-query
330# @internal-function depend-java-query 286# @INTERNAL
331# 287# @DESCRIPTION:
332# 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.
333# 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
334# do not handle use flags. 290# do not handle use flags.
335# ------------------------------------------------------------------------------
336
337depend-java-query() { 291depend-java-query() {
338 # 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
339 # that had some weird bashrc voodoo for which. 293 # that had some weird bashrc voodoo for which.
340 USE="${USE}" /usr/bin/depend-java-query "${@}" 294 USE="${USE}" /usr/bin/depend-java-query "${@}"
341} 295}
342 296
343# ------------------------------------------------------------------------------ 297# @FUNCTION: java-pkg_regjar
344# @ebuild-function java-pkg_regjar 298# @USAGE: </path/to/installed/jar>
345# 299# @DESCRIPTION:
346# Records an already installed jar in the package.env 300# Records an already installed (in ${D}) jar in the package.env
347# 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
348# install things. 302# install things.
349# 303#
350# Example:
351# java-pkg_regjar ${D}/opt/foo/lib/foo.jar
352#
353# WARNING: 304# WARNING:
354# 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
355# 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:
356# 307#
357# java-pkg_regjar /opt/my-java/lib/*.jar 308# @CODE
358#
359# will not work, because:
360# * the `for jar in "$@"` can't expand the path to jar file names, as they
361# don't exist yet
362# * all `if ...` inside for will fail - the file '/opt/my-java/lib/*.jar'
363# doesn't exist
364#
365# you have to use it as:
366#
367# java-pkg_regjar ${D}/opt/my-java/lib/*.jar 309# java-pkg_regjar ${D}/opt/my-java/lib/*.jar
310# @CODE
368# 311#
369# @param $@ - jars to record 312
370# ------------------------------------------------------------------------------
371# 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?
372java-pkg_regjar() { 314java-pkg_regjar() {
373 debug-print-function ${FUNCNAME} $* 315 debug-print-function ${FUNCNAME} $*
374 316
375 java-pkg_check-phase install 317 java-pkg_check-phase install
406 done 348 done
407 349
408 java-pkg_do_write_ 350 java-pkg_do_write_
409} 351}
410 352
411# ------------------------------------------------------------------------------ 353# @FUNCTION: java-pkg_newjar
412# @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)
413# 357#
414# Installs a jar with a new name
415#
416# @example: install a versioned jar without the version 358# For example, installs a versioned jar without the version
417# java-pkg_newjar dist/${P}.jar ${PN}.jar
418#
419# @param $1 - jar to install
420# @param $2 - new name for jar - defaults to ${PN}.jar if not specified
421# ------------------------------------------------------------------------------
422java-pkg_newjar() { 359java-pkg_newjar() {
423 debug-print-function ${FUNCNAME} $* 360 debug-print-function ${FUNCNAME} $*
424 361
425 local original_jar="${1}" 362 local original_jar="${1}"
426 local new_jar="${2:-${PN}.jar}" 363 local new_jar="${2:-${PN}.jar}"
434 cp "${original_jar}" "${new_jar_dest}" \ 371 cp "${original_jar}" "${new_jar_dest}" \
435 || die "Failed to copy ${original_jar} to ${new_jar_dest}" 372 || die "Failed to copy ${original_jar} to ${new_jar_dest}"
436 java-pkg_dojar "${new_jar_dest}" 373 java-pkg_dojar "${new_jar_dest}"
437} 374}
438 375
439# ------------------------------------------------------------------------------ 376# @FUNCTION: java-pkg_addcp
440# @ebuild-function java-pkg_addcp 377# @USAGE: <classpath>
441# 378# @DESCRIPTION:
442# 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,
443# 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.
444# 381# The parameters of this function are appended to JAVA_PKG_CLASSPATH
445# TODO add example
446# @param $@ - value to append to JAVA_PKG_CLASSPATH
447# ------------------------------------------------------------------------------
448java-pkg_addcp() { 382java-pkg_addcp() {
449 java-pkg_append_ JAVA_PKG_CLASSPATH "${@}" 383 java-pkg_append_ JAVA_PKG_CLASSPATH "${@}"
450 java-pkg_do_write_ 384 java-pkg_do_write_
451} 385}
452 386
453# ------------------------------------------------------------------------------ 387# @FUNCTION: java-pkg_doso
454# @ebuild-function java-pkg_doso 388# @USAGE: <path/to/file1.so> [...]
455# 389# @DESCRIPTION:
456# Installs any number of JNI libraries 390# Installs any number of JNI libraries
457# 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
458# can be used change this path 392# can be used change this path
459# 393#
394# @CODE
460# Example: 395# Example:
461# java-pkg_doso *.so 396# java-pkg_doso *.so
462# 397# @CODE
463# @param $@ - JNI libraries to install
464# ------------------------------------------------------------------------------
465java-pkg_doso() { 398java-pkg_doso() {
466 debug-print-function ${FUNCNAME} $* 399 debug-print-function ${FUNCNAME} $*
467 400
468 java-pkg_check-phase install 401 java-pkg_check-phase install
469 402
495 done 428 done
496 429
497 java-pkg_do_write_ 430 java-pkg_do_write_
498} 431}
499 432
500# ------------------------------------------------------------------------------ 433# @FUNCTION: java-pkg_regso
501# @ebuild-function java-pkg_regso 434# @USAGE: <file1.so> [...]
502# 435# @DESCRIPTION:
503# 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
504# 441#
505# Example: 442# Example:
506# java-pkg_regso *.so /path/*.so 443# java-pkg_regso *.so /path/*.so
507# 444# @CODE
508# @param $@ - JNI libraries to register
509# ------------------------------------------------------------------------------
510java-pkg_regso() { 445java-pkg_regso() {
511 debug-print-function ${FUNCNAME} $* 446 debug-print-function ${FUNCNAME} $*
512 447
513 java-pkg_check-phase install 448 java-pkg_check-phase install
514 449
532 done 467 done
533 468
534 java-pkg_do_write_ 469 java-pkg_do_write_
535} 470}
536 471
537# ------------------------------------------------------------------------------ 472# @FUNCTION: java-pkg_jarinto
538# @ebuild-function java-pkg_jarinto 473# @USAGE: </path/to/install/jars/into>
539# 474# @DESCRIPTION:
540# Changes the path jars are installed into 475# Changes the path jars are installed into via subsequent java-pkg_dojar calls.
541#
542# @param $1 - new location to install jars into.
543# -----------------------------------------------------------------------------
544java-pkg_jarinto() { 476java-pkg_jarinto() {
545 debug-print-function ${FUNCNAME} $* 477 debug-print-function ${FUNCNAME} $*
546 478
547 JAVA_PKG_JARDEST="${1}" 479 JAVA_PKG_JARDEST="${1}"
548} 480}
549 481
550# ------------------------------------------------------------------------------ 482# @FUNCTION: java-pkg_sointo
551# @ebuild-function java-pkg_sointo 483# @USAGE: </path/to/install/sofiles/into>
552# 484# @DESCRIPTION:
553# Changes the path that JNI libraries are installed into. 485# Changes the path that JNI libraries are installed into via subsequent
554# 486# java-pkg_doso calls.
555# @param $1 - new location to install JNI libraries into.
556# ------------------------------------------------------------------------------
557java-pkg_sointo() { 487java-pkg_sointo() {
558 debug-print-function ${FUNCNAME} $* 488 debug-print-function ${FUNCNAME} $*
559 489
560 JAVA_PKG_LIBDEST="${1}" 490 JAVA_PKG_LIBDEST="${1}"
561} 491}
562 492
563# ------------------------------------------------------------------------------ 493# @FUNCTION: java-pkg_dohtml
564# @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.
565# 497#
566# Install Javadoc HTML documentation 498# @CODE
567#
568# @example
569# java-pkg_dohtml dist/docs/ 499# java-pkg_dohtml dist/docs/
570# 500# @CODE
571# ------------------------------------------------------------------------------
572java-pkg_dohtml() { 501java-pkg_dohtml() {
573 debug-print-function ${FUNCNAME} $* 502 debug-print-function ${FUNCNAME} $*
574 503
575 [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}" 504 [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}"
576 505
582 # a reasonable way to catch # docs for all of the 511 # a reasonable way to catch # docs for all of the
583 # old ebuilds. 512 # old ebuilds.
584 java-pkg_recordjavadoc 513 java-pkg_recordjavadoc
585} 514}
586 515
587# ------------------------------------------------------------------------------ 516# @FUNCTION: java-pkg_dojavadoc
588# @ebuild-function java-pkg_dojavadoc 517# @USAGE: [--symlink destination] <path/to/javadocs/root>
589# 518# @DESCRIPTION:
590# 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.
591# 520#
521# @CODE
522# Parameters:
592# @param $1: optional --symlink creates to symlink like this for html 523# $1: optional --symlink creates to symlink like this for html
593# documentation bundles. 524# documentation bundles.
594# @param $2: - The javadoc root directory. 525# $2: - The javadoc root directory.
595# 526#
596# @example: 527# Examples:
597# java-pkg_dojavadoc docs/api 528# java-pkg_dojavadoc docs/api
598# java-pkg_dojavadoc --symlink apidocs docs/api 529# java-pkg_dojavadoc --symlink apidocs docs/api
599# 530# @CODE
600# ------------------------------------------------------------------------------
601java-pkg_dojavadoc() { 531java-pkg_dojavadoc() {
602 debug-print-function ${FUNCNAME} $* 532 debug-print-function ${FUNCNAME} $*
603 533
604 # For html documentation bundles that link to Javadoc 534 # For html documentation bundles that link to Javadoc
605 local symlink 535 local symlink
612 local dest=/usr/share/doc/${PF}/html 542 local dest=/usr/share/doc/${PF}/html
613 543
614 # QA checks 544 # QA checks
615 545
616 java-pkg_check-phase install 546 java-pkg_check-phase install
547 java-pkg_init_paths_
617 548
618 [[ -z "${dir}" ]] && die "Must specify a directory!" 549 [[ -z "${dir}" ]] && die "Must specify a directory!"
619 [[ ! -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!"
620 if [[ ! -e "${dir}/index.html" ]]; then 551 if [[ ! -e "${dir}/index.html" ]]; then
621 local msg="No index.html in javadoc directory" 552 local msg="No index.html in javadoc directory"
648 debug-print "symlinking ${dest}/{api,${symlink}}" 579 debug-print "symlinking ${dest}/{api,${symlink}}"
649 dosym ${dest}/{api,${symlink}} || die 580 dosym ${dest}/{api,${symlink}} || die
650 fi 581 fi
651} 582}
652 583
653# ------------------------------------------------------------------------------ 584# @FUNCTION: java-pkg_dosrc
654# @ebuild-function java-pkg_dosrc 585# @USAGE: <path/to/sources> [...]
655# 586# @DESCRIPTION:
656# 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
657# 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.
658# 590#
659# Ebuild needs to DEPEND on app-arch/zip to use this. 591# @CODE
660#
661# It also should be controlled by USE=source.
662#
663# @example: 592# Example:
664# java-pkg_dosrc src/* 593# java-pkg_dosrc src/*
665# 594# @CODE
666# ------------------------------------------------------------------------------ 595
667# 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
668# source -nichoj 597# source -nichoj
598#
669# 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#
670# TODO maybe we can take an existing zip/jar? -nichoj 601# TODO maybe we can take an existing zip/jar? -nichoj
602#
671# FIXME apparently this fails if you give it an empty directories 603# FIXME apparently this fails if you give it an empty directories
672java-pkg_dosrc() { 604java-pkg_dosrc() {
673 debug-print-function ${FUNCNAME} $* 605 debug-print-function ${FUNCNAME} $*
674 606
675 [ ${#} -lt 1 ] && die "At least one argument needed" 607 [ ${#} -lt 1 ] && die "At least one argument needed"
707 639
708 JAVA_SOURCES="${JAVA_PKG_SOURCESPATH}/${zip_name}" 640 JAVA_SOURCES="${JAVA_PKG_SOURCESPATH}/${zip_name}"
709 java-pkg_do_write_ 641 java-pkg_do_write_
710} 642}
711 643
712# ------------------------------------------------------------------------------ 644# @FUNCTION: java-pkg_dolauncher
713# @ebuild-function java-pkg_dolauncher 645# @USAGE: <filename> [options]
714# 646# @DESCRIPTION:
715# Make a wrapper script to lauch/start this package 647# Make a wrapper script to lauch/start this package
716# If necessary, the wrapper will switch to the appropriate VM. 648# If necessary, the wrapper will switch to the appropriate VM.
717# 649#
718# 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
719# 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}.
720# 652#
653# @CODE
654# Parameters:
721# @param $1 - filename of launcher to create 655# $1 - filename of launcher to create
722# @param $2 - options, as follows: 656# $2 - options, as follows:
723# --main the.main.class.too.start 657# --main the.main.class.to.start
724# --jar /the/jar/too/launch.jar or just <name>.jar 658# --jar /the/jar/too/launch.jar or just <name>.jar
725# --java_args 'Extra arguments to pass to java' 659# --java_args 'Extra arguments to pass to java'
726# --pkg_args 'Extra arguments to pass to the package' 660# --pkg_args 'Extra arguments to pass to the package'
727# --pwd Directory the launcher changes to before executing java 661# --pwd Directory the launcher changes to before executing java
728# -into Directory to install the launcher to, instead of /usr/bin 662# -into Directory to install the launcher to, instead of /usr/bin
729# -pre Prepend contents of this file to the launcher 663# -pre Prepend contents of this file to the launcher
730# ------------------------------------------------------------------------------ 664# @CODE
731java-pkg_dolauncher() { 665java-pkg_dolauncher() {
732 debug-print-function ${FUNCNAME} $* 666 debug-print-function ${FUNCNAME} $*
733 667
734 java-pkg_check-phase install 668 java-pkg_check-phase install
735 java-pkg_init_paths_ 669 java-pkg_init_paths_
796 else 730 else
797 dobin "${target}" 731 dobin "${target}"
798 fi 732 fi
799} 733}
800 734
801# ------------------------------------------------------------------------------ 735# @FUNCTION: java-pkg_dowar
736# @DESCRIPTION:
802# Install war files. 737# Install war files.
803# TODO document 738# TODO document
804# ------------------------------------------------------------------------------
805java-pkg_dowar() { 739java-pkg_dowar() {
806 debug-print-function ${FUNCNAME} $* 740 debug-print-function ${FUNCNAME} $*
807 741
808 # Check for arguments 742 # Check for arguments
809 [[ ${#} -lt 1 ]] && die "At least one argument needed" 743 [[ ${#} -lt 1 ]] && die "At least one argument needed"
833 INSDESTTREE=${JAVA_PKG_WARDEST} \ 767 INSDESTTREE=${JAVA_PKG_WARDEST} \
834 doins ${warpath} 768 doins ${warpath}
835 done 769 done
836} 770}
837 771
838# ------------------------------------------------------------------------------ 772# @FUNCTION: java-pkg_recordjavadoc
839# @internal-function java-pkg_recordjavadoc 773# @INTERNAL
774# @DESCRIPTION:
840# 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
841# 776
842# TODO make sure this in the proper section 777# TODO make sure this in the proper section
843# ------------------------------------------------------------------------------
844java-pkg_recordjavadoc() 778java-pkg_recordjavadoc()
845{ 779{
846 debug-print-function ${FUNCNAME} $* 780 debug-print-function ${FUNCNAME} $*
847 # the find statement is important 781 # the find statement is important
848 # as some packages include multiple trees of javadoc 782 # as some packages include multiple trees of javadoc
855 else 789 else
856 debug-print "No javadocs found" 790 debug-print "No javadocs found"
857 fi 791 fi
858} 792}
859 793
860# ------------------------------------------------------------------------------
861# @section-end install
862# ------------------------------------------------------------------------------
863 794
864# ------------------------------------------------------------------------------ 795# @FUNCTION: java-pkg_jar-from
865# @begin-section query 796# @USAGE: [--build-only] [--with-dependencies] [--virtual] [--into dir] <package> [<package.jar>] [<destination.jar>]
866# Use these to build the classpath for building a package. 797# @DESCRIPTION:
867# ------------------------------------------------------------------------------
868
869# ------------------------------------------------------------------------------
870# @ebuild-function java-pkg_jar-from
871#
872# Makes a symlink to a jar from a certain package 798# Makes a symlink to a jar from a certain package
873# A lot of java packages include dependencies in a lib/ directory 799# A lot of java packages include dependencies in a lib/ directory
874# You can use this function to replace these bundled dependencies. 800# You can use this function to replace these bundled dependencies.
875# 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"
876# 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
877# 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).
878# 804#
805# @CODE
879# Example: get all jars from xerces slot 2 806# Example: get all jars from xerces slot 2
880# java-pkg_jar-from xerces-2 807# java-pkg_jar-from xerces-2
808#
881# Example: get a specific jar from xerces slot 2 809# Example: get a specific jar from xerces slot 2
882# java-pkg_jar-from xerces-2 xml-apis.jar 810# java-pkg_jar-from xerces-2 xml-apis.jar
811#
883# 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
884# java-pkg_jar-from xerces-2 xml-apis.jar xml.jar 813# java-pkg_jar-from xerces-2 xml-apis.jar xml.jar
814#
885# Example: get junit.jar which is needed only for building 815# Example: get junit.jar which is needed only for building
886# java-pkg_jar-from --build-only junit junit.jar 816# java-pkg_jar-from --build-only junit junit.jar
817# @CODE
887# 818#
888# @param $opt 819# @CODE
820# Parameters
889# --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.
890# (assumed automatically when called inside src_test) 822# (assumed automatically when called inside src_test)
891# --with-dependencies - get jars also from requested package's dependencies 823# --with-dependencies - get jars also from requested package's dependencies
892# transitively. 824# transitively.
893# --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
894# and will not have individual jar dependencies recorded. 826# and will not have individual jar dependencies recorded.
895# --into $dir - symlink jar(s) into $dir (must exist) instead of . 827# --into $dir - symlink jar(s) into $dir (must exist) instead of .
896# @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
897# case other parameters are not used. 829# case other parameters are not used.
898# @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.
899# @param $3 - When a single jar is specified, destination filename of the 831# $3 - When a single jar is specified, destination filename of the
900# symlink. Defaults to the name of the jar. 832# symlink. Defaults to the name of the jar.
901# ------------------------------------------------------------------------------ 833# @CODE
834
902# TODO could probably be cleaned up a little 835# TODO could probably be cleaned up a little
903java-pkg_jar-from() { 836java-pkg_jar-from() {
904 debug-print-function ${FUNCNAME} $* 837 debug-print-function ${FUNCNAME} $*
905 838
906 local build_only="" 839 local build_only=""
1011 else 944 else
1012 die "Failed to find ${target_jar:-jar} in ${target_pkg}" 945 die "Failed to find ${target_jar:-jar} in ${target_pkg}"
1013 fi 946 fi
1014} 947}
1015 948
1016# ------------------------------------------------------------------------------ 949# @FUNCTION: java-pkg_jarfrom
1017# @ebuild-function java-pkg_jarfrom 950# @DESCRIPTION:
1018#
1019# See java-pkg_jar-from 951# See java-pkg_jar-from
1020# ------------------------------------------------------------------------------
1021java-pkg_jarfrom() { 952java-pkg_jarfrom() {
1022 java-pkg_jar-from "$@" 953 java-pkg_jar-from "$@"
1023} 954}
1024 955
1025# ------------------------------------------------------------------------------ 956# @FUNCTION: java-pkg_getjars
1026# @ebuild-function java-pkg_getjars 957# @USAGE: [--build-only] [--with-dependencies] <package1>[,<package2>...]
1027# 958# @DESCRIPTION:
1028# Get the classpath provided by any number of packages 959# Get the classpath provided by any number of packages
1029# 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'.
1030# The providing packages are recorded as dependencies into package.env DEPEND 961# The providing packages are recorded as dependencies into package.env DEPEND
1031# 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
1032# 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
1033# (junit testing etc). 964# (junit testing etc).
1034# 965#
966# @CODE
1035# Example: Get the classpath for xerces-2 and xalan, 967# Example: Get the classpath for xerces-2 and xalan,
1036# java-pkg_getjars xerces-2,xalan 968# java-pkg_getjars xerces-2,xalan
969#
1037# Example Return: 970# Example Return:
1038# /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
1039# 972#
1040# @param $opt 973#
974# Parameters:
1041# --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.
1042# (assumed automatically when called inside src_test) 976# (assumed automatically when called inside src_test)
1043# --with-dependencies - get jars also from requested package's dependencies 977# --with-dependencies - get jars also from requested package's dependencies
1044# transitively. 978# transitively.
1045# @param $1 - list of packages to get jars from 979# $1 - list of packages to get jars from
1046# (passed to java-config --classpath) 980# (passed to java-config --classpath)
1047# ------------------------------------------------------------------------------ 981# @CODE
1048java-pkg_getjars() { 982java-pkg_getjars() {
1049 debug-print-function ${FUNCNAME} $* 983 debug-print-function ${FUNCNAME} $*
1050 984
1051 local build_only="" 985 local build_only=""
1052 local deep="" 986 local deep=""
1090 done 1024 done
1091 1025
1092 echo "${jars}" 1026 echo "${jars}"
1093} 1027}
1094 1028
1095# ------------------------------------------------------------------------------ 1029# @FUNCTION: java-pkg_getjar
1096# @ebuild-function java-pkg_getjar 1030# @USAGE: [--build-only] [--virtual] <package> <jarfile>
1097# 1031# @DESCRIPTION:
1098# Get the filename of a single jar from a package 1032# Get the complete path of a single jar from a package
1099# The providing package is recorded as runtime dependency into package.env 1033# The providing package is recorded as runtime dependency into package.env
1100# 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
1101# 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
1102# (junit testing etc). 1036# (junit testing etc).
1103# 1037#
1038# @CODE
1104# @example 1039# Example:
1105# java-pkg_getjar xerces-2 xml-apis.jar 1040# java-pkg_getjar xerces-2 xml-apis.jar
1106# @example-return 1041# returns
1107# /usr/share/xerces-2/lib/xml-apis.jar 1042# /usr/share/xerces-2/lib/xml-apis.jar
1108# 1043#
1109# @param $opt 1044# Parameters:
1110# --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.
1111# --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
1112# and will not have individual jar dependencies recorded. 1047# and will not have individual jar dependencies recorded.
1113# @param $1 - package to use 1048# $1 - package to use
1114# @param $2 - jar to get 1049# $2 - jar to get
1115# ------------------------------------------------------------------------------ 1050# @CODE
1116java-pkg_getjar() { 1051java-pkg_getjar() {
1117 debug-print-function ${FUNCNAME} $* 1052 debug-print-function ${FUNCNAME} $*
1118 1053
1119 local build_only="" 1054 local build_only=""
1120 local virtual="" 1055 local virtual=""
1183 1118
1184 die "Could not find ${target_jar} in ${pkg}" 1119 die "Could not find ${target_jar} in ${pkg}"
1185 return 1 1120 return 1
1186} 1121}
1187 1122
1188# ------------------------------------------------------------------------------ 1123# @FUNCTION: java-pkg_register-dependency
1189# @ebuild-function java-pkg_register-dependency 1124# @USAGE: <package>[,<package2>...] [<jarfile>]
1190# 1125# @DESCRIPTION:
1191# 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
1192# 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
1193# src_install phase. 1128# src_install phase.
1194# 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
1195# 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
1196# specified in ebuild's RDEPEND, and should be omitted in DEPEND. 1131# specified in ebuild's RDEPEND, and should be omitted in DEPEND.
1197# 1132#
1133# @CODE
1134# Parameters:
1198# @param $1 - comma-separated list of packages, or a single package 1135# $1 - comma-separated list of packages, or a single package
1199# @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
1200# to depend on 1137# to depend on
1201# 1138#
1139# Examples:
1202# Example: Record the dependency on whole xerces-2 and xalan, 1140# Record the dependency on whole xerces-2 and xalan,
1203# java-pkg_register-dependency xerces-2,xalan 1141# java-pkg_register-dependency xerces-2,xalan
1142#
1204# Example: Record the dependency on ant.jar from ant-core 1143# Record the dependency on ant.jar from ant-core
1205# java-pkg_register-dependency ant-core ant.jar 1144# java-pkg_register-dependency ant-core ant.jar
1145# @CODE
1206# 1146#
1207# 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
1208# 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
1209# 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
1210# there are more packages providing identically named jar without class 1150# there are more packages providing identically named jar without class
1211# collisions. 1151# collisions.
1212# ------------------------------------------------------------------------------
1213java-pkg_register-dependency() { 1152java-pkg_register-dependency() {
1214 debug-print-function ${FUNCNAME} $* 1153 debug-print-function ${FUNCNAME} $*
1215 1154
1216 java-pkg_check-phase install 1155 java-pkg_check-phase install
1217 1156
1239 fi 1178 fi
1240 1179
1241 java-pkg_do_write_ 1180 java-pkg_do_write_
1242} 1181}
1243 1182
1244# ------------------------------------------------------------------------------
1245# @ebuild-function java-pkg_register-optional-dependency 1183# @FUNCTION: java-pkg_register-optional-dependency
1246# 1184# @USAGE: <package>[,<package2>...] [<jarfile>]
1185# @DESCRIPTION:
1247# 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
1248# 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
1249# called in src_install phase. 1188# called in src_install phase.
1250# 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.
1251# 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
1252# 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
1253# for each implementation triggering hard dependency. 1192# for each implementation triggering hard dependency.
1254# 1193#
1194# @CODE
1195# Parameters:
1255# @param $1 - comma-separated list of packages, or a single package 1196# $1 - comma-separated list of packages, or a single package
1256# @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
1257# to depend on
1258# 1198#
1199# Example:
1259# Example: Record the optional dependency on some jdbc providers 1200# Record the optional dependency on some jdbc providers
1260# 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
1261# 1203#
1262# 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
1263# 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
1264# 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
1265# there are more packages providing identically named jar without class 1207# there are more packages providing identically named jar without class
1266# collisions. 1208# collisions.
1267# ------------------------------------------------------------------------------
1268java-pkg_register-optional-dependency() { 1209java-pkg_register-optional-dependency() {
1269 debug-print-function ${FUNCNAME} $* 1210 debug-print-function ${FUNCNAME} $*
1270 1211
1271 java-pkg_check-phase install 1212 java-pkg_check-phase install
1272 1213
1292 fi 1233 fi
1293 1234
1294 java-pkg_do_write_ 1235 java-pkg_do_write_
1295} 1236}
1296 1237
1297# ------------------------------------------------------------------------------
1298# @ebuild-function java-pkg_register-environment-variable 1238# @FUNCTION: java-pkg_register-environment-variable
1299# 1239# @USAGE: <name> <value>
1240# @DESCRIPTION:
1300# Register an arbitrary environment variable into package.env. The gjl launcher 1241# Register an arbitrary environment variable into package.env. The gjl launcher
1301# 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
1302# environement before executing java command. 1243# environement before executing java command.
1303# Must only be called in src_install phase. 1244# Must only be called in src_install phase.
1304#
1305# @param $1 - variable name
1306# @param $2 - variable value
1307# ------------------------------------------------------------------------------
1308JAVA_PKG_EXTRA_ENV="${T}/java-pkg-extra-env" 1245JAVA_PKG_EXTRA_ENV="${T}/java-pkg-extra-env"
1309JAVA_PKG_EXTRA_ENV_VARS="" 1246JAVA_PKG_EXTRA_ENV_VARS=""
1310java-pkg_register-environment-variable() { 1247java-pkg_register-environment-variable() {
1311 debug-print-function ${FUNCNAME} $* 1248 debug-print-function ${FUNCNAME} $*
1312 1249
1318 JAVA_PKG_EXTRA_ENV_VARS="${JAVA_PKG_EXTRA_ENV_VARS} ${1}" 1255 JAVA_PKG_EXTRA_ENV_VARS="${JAVA_PKG_EXTRA_ENV_VARS} ${1}"
1319 1256
1320 java-pkg_do_write_ 1257 java-pkg_do_write_
1321} 1258}
1322 1259
1323# ------------------------------------------------------------------------------ 1260# @FUNCTION: java-pkg_get-bootclasspath
1324# @ebuild-function java-pkg_get-bootclasspath 1261# @USAGE: <version>
1325# 1262# @DESCRIPTION:
1326# Returns classpath of a given bootclasspath-providing package version. 1263# Returns classpath of a given bootclasspath-providing package version.
1327# 1264#
1328# @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
1329# of the current JDK 1266# of the current JDK
1330# ------------------------------------------------------------------------------
1331
1332java-pkg_get-bootclasspath() { 1267java-pkg_get-bootclasspath() {
1333 local version="${1}" 1268 local version="${1}"
1334 1269
1335 local bcp 1270 local bcp
1336 case "${version}" in 1271 case "${version}" in
1384# 1319#
1385# read line 1320# read line
1386# done 1321# done
1387#} 1322#}
1388 1323
1389# ------------------------------------------------------------------------------ 1324# @FUNCTION: java-pkg_find-normal-jars
1390# @section-end query 1325# @USAGE: [<path/to/directory>]
1391# ------------------------------------------------------------------------------ 1326# @DESCRIPTION:
1392
1393# ------------------------------------------------------------------------------
1394# @section-begin helper
1395# @section-summary Helper functions
1396#
1397# Various other functions to use from an ebuild
1398# ------------------------------------------------------------------------------
1399
1400# ------------------------------------------------------------------------------
1401# @ebuild-function java-pkg_find-normal-jars
1402#
1403# 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)
1404#
1405# @param $1 - The directory to search for jar files (default: ${WORKDIR})
1406# ------------------------------------------------------------------------------
1407java-pkg_find-normal-jars() { 1328java-pkg_find-normal-jars() {
1408 local dir=$1 1329 local dir=$1
1409 [[ "${dir}" ]] || dir="${WORKDIR}" 1330 [[ "${dir}" ]] || dir="${WORKDIR}"
1410 local found 1331 local found
1411 for jar in $(find "${dir}" -name "*.jar" -type f); do 1332 for jar in $(find "${dir}" -name "*.jar" -type f); do
1414 done 1335 done
1415 [[ "${found}" ]] 1336 [[ "${found}" ]]
1416 return $? 1337 return $?
1417} 1338}
1418 1339
1419# ------------------------------------------------------------------------------ 1340# @FUNCTION: java-pkg_ensure-no-bundled-jars
1420# @ebuild-function java-pkg_ensure-no-bundled-jars 1341# @DESCRIPTION:
1421#
1422# 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.
1423# 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
1424# to system jar files or bundled jars removed. 1344# to system jar files or bundled jars removed.
1425# ------------------------------------------------------------------------------
1426java-pkg_ensure-no-bundled-jars() { 1345java-pkg_ensure-no-bundled-jars() {
1427 debug-print-function ${FUNCNAME} $* 1346 debug-print-function ${FUNCNAME} $*
1428 1347
1429 local bundled_jars=$(java-pkg_find-normal-jars) 1348 local bundled_jars=$(java-pkg_find-normal-jars)
1430 if [[ -n ${bundled_jars} ]]; then 1349 if [[ -n ${bundled_jars} ]]; then
1435 done 1354 done
1436 die "Bundled jars found!" 1355 die "Bundled jars found!"
1437 fi 1356 fi
1438} 1357}
1439 1358
1440# ------------------------------------------------------------------------------
1441# @internal-function java-pkg_ensure-vm-version-sufficient 1359# @FUNCTION: java-pkg_ensure-vm-version-sufficient
1442# 1360# @INTERNAL
1361# @DESCRIPTION:
1443# 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.
1444#
1445# ------------------------------------------------------------------------------
1446java-pkg_ensure-vm-version-sufficient() { 1363java-pkg_ensure-vm-version-sufficient() {
1447 debug-print-function ${FUNCNAME} $* 1364 debug-print-function ${FUNCNAME} $*
1448 1365
1449 if ! java-pkg_is-vm-version-sufficient; then 1366 if ! java-pkg_is-vm-version-sufficient; then
1450 debug-print "VM is not suffient" 1367 debug-print "VM is not suffient"
1452 einfo "Please use java-config -S to set the correct one" 1369 einfo "Please use java-config -S to set the correct one"
1453 die "Active Java VM cannot build this package" 1370 die "Active Java VM cannot build this package"
1454 fi 1371 fi
1455} 1372}
1456 1373
1457# ------------------------------------------------------------------------------ 1374# @FUNCTION: java-pkg_is-vm-version-sufficient
1458# @internal-function java-pkg_is-vm-version-sufficient 1375# @INTERNAL
1459# 1376# @DESCRIPTION:
1460# @return zero - VM is sufficient 1377# @RETURN: zero - VM is sufficient; non-zero - VM is not sufficient
1461# @return non-zero - VM is not sufficient
1462# ------------------------------------------------------------------------------
1463java-pkg_is-vm-version-sufficient() { 1378java-pkg_is-vm-version-sufficient() {
1464 debug-print-function ${FUNCNAME} $* 1379 debug-print-function ${FUNCNAME} $*
1465 1380
1466 depend-java-query --is-sufficient "${DEPEND}" > /dev/null 1381 depend-java-query --is-sufficient "${DEPEND}" > /dev/null
1467 return $? 1382 return $?
1468} 1383}
1469 1384
1470# ------------------------------------------------------------------------------ 1385# @FUNCTION: java-pkg_ensure-vm-version-eq
1471# @internal-function java-pkg_ensure-vm-version-eq 1386# @INTERNAL
1472# 1387# @DESCRIPTION:
1473# 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.
1474# 1389#
1475# @param $@ - Desired VM version to ensure 1390# @param $@ - Desired VM version to ensure
1476# ------------------------------------------------------------------------------
1477java-pkg_ensure-vm-version-eq() { 1391java-pkg_ensure-vm-version-eq() {
1478 debug-print-function ${FUNCNAME} $* 1392 debug-print-function ${FUNCNAME} $*
1479 1393
1480 if ! java-pkg_is-vm-version-eq $@ ; then 1394 if ! java-pkg_is-vm-version-eq $@ ; then
1481 debug-print "VM is not suffient" 1395 debug-print "VM is not suffient"
1483 einfo "Please use java-config -S to set the correct one" 1397 einfo "Please use java-config -S to set the correct one"
1484 die "Active Java VM too old" 1398 die "Active Java VM too old"
1485 fi 1399 fi
1486} 1400}
1487 1401
1488# ------------------------------------------------------------------------------ 1402# @FUNCTION: java-pkg_is-vm-version-eq
1489# @internal-function java-pkg_is-vm-version-eq 1403# @USAGE: <version>
1490# 1404# @INTERNAL
1491# @param $@ - VM version to compare current VM to 1405# @RETURN: zero - VM versions are equal; non-zero - VM version are not equal
1492# @return zero - VM versions are equal
1493# @return non-zero - VM version are not equal
1494# ------------------------------------------------------------------------------
1495java-pkg_is-vm-version-eq() { 1406java-pkg_is-vm-version-eq() {
1496 debug-print-function ${FUNCNAME} $* 1407 debug-print-function ${FUNCNAME} $*
1497 1408
1498 local needed_version="$@" 1409 local needed_version="$@"
1499 1410
1516 return 1 1427 return 1
1517 fi 1428 fi
1518 fi 1429 fi
1519} 1430}
1520 1431
1521# ------------------------------------------------------------------------------ 1432# @FUNCTION: java-pkg_ensure-vm-version-ge
1522# @internal-function java-pkg_ensure-vm-version-ge 1433# @INTERNAL
1523# 1434# @DESCRIPTION:
1524# 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
1525# 1436#
1526# @param $@ - VM version to compare current to 1437# @param $@ - VM version to compare current to
1527# ------------------------------------------------------------------------------
1528java-pkg_ensure-vm-version-ge() { 1438java-pkg_ensure-vm-version-ge() {
1529 debug-print-function ${FUNCNAME} $* 1439 debug-print-function ${FUNCNAME} $*
1530 1440
1531 if ! java-pkg_is-vm-version-ge "$@" ; then 1441 if ! java-pkg_is-vm-version-ge "$@" ; then
1532 debug-print "vm is not suffient" 1442 debug-print "vm is not suffient"
1534 einfo "Please use java-config -S to set the correct one" 1444 einfo "Please use java-config -S to set the correct one"
1535 die "Active Java VM too old" 1445 die "Active Java VM too old"
1536 fi 1446 fi
1537} 1447}
1538 1448
1539# ------------------------------------------------------------------------------ 1449# @FUNCTION: java-pkg_is-vm-version-ge
1540# @internal-function java-pkg_is-vm-version-ge 1450# @INTERNAL
1541# 1451# @DESCRIPTION:
1452# @CODE
1453# Parameters:
1542# @param $@ - VM version to compare current VM to 1454# $@ - VM version to compare current VM to
1455# @CODE
1543# @return zero - current VM version is greater than checked version 1456# @RETURN: zero - current VM version is greater than checked version;
1544# @return non-zero - current VM version is not greater than checked version 1457# non-zero - current VM version is not greater than checked version
1545# ------------------------------------------------------------------------------
1546java-pkg_is-vm-version-ge() { 1458java-pkg_is-vm-version-ge() {
1547 debug-print-function ${FUNCNAME} $* 1459 debug-print-function ${FUNCNAME} $*
1548 1460
1549 local needed_version=$@ 1461 local needed_version=$@
1550 local vm_version=$(java-pkg_get-vm-version) 1462 local vm_version=$(java-pkg_get-vm-version)
1573java-pkg_current-vm-matches() { 1485java-pkg_current-vm-matches() {
1574 has $(java-pkg_get-current-vm) ${@} 1486 has $(java-pkg_get-current-vm) ${@}
1575 return $? 1487 return $?
1576} 1488}
1577 1489
1578# ------------------------------------------------------------------------------ 1490# @FUNCTION: java-pkg_get-source
1579# @ebuild-function java-pkg_get-source 1491# @DESCRIPTION:
1580#
1581# Determines what source version should be used, for passing to -source. 1492# Determines what source version should be used, for passing to -source.
1582# 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
1583# 1494#
1584# @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
1585# ------------------------------------------------------------------------------
1586java-pkg_get-source() { 1496java-pkg_get-source() {
1587 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}")}
1588} 1498}
1589 1499
1590# ------------------------------------------------------------------------------ 1500# @FUNCTION: java-pkg_get-target
1591# @ebuild-function java-pkg_get-target 1501# @DESCRIPTION:
1592#
1593# Determines what target version should be used, for passing to -target. 1502# Determines what target version should be used, for passing to -target.
1594# 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
1595# version of your JDK. 1504# version of your JDK.
1596# 1505#
1597# @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
1598# ------------------------------------------------------------------------------
1599java-pkg_get-target() { 1507java-pkg_get-target() {
1600 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}")}
1601} 1509}
1602 1510
1511# @FUNCTION: java-pkg_get-javac
1512# @DESCRIPTION:
1513# Returns the compiler executable
1603java-pkg_get-javac() { 1514java-pkg_get-javac() {
1604 debug-print-function ${FUNCNAME} $* 1515 debug-print-function ${FUNCNAME} $*
1605 1516
1606 1517
1607 local compiler="${GENTOO_COMPILER}" 1518 local compiler="${GENTOO_COMPILER}"
1637 fi 1548 fi
1638 fi 1549 fi
1639 echo ${compiler_executable} 1550 echo ${compiler_executable}
1640} 1551}
1641 1552
1642# ------------------------------------------------------------------------------ 1553# @FUNCTION: java-pkg_javac-args
1643# @ebuild-function java-pkg_javac-args 1554# @DESCRIPTION:
1644#
1645# 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
1646# to know what -source/-target to use. 1556# to know what -source/-target to use.
1647# 1557#
1648# @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
1649# ------------------------------------------------------------------------------
1650java-pkg_javac-args() { 1559java-pkg_javac-args() {
1651 debug-print-function ${FUNCNAME} $* 1560 debug-print-function ${FUNCNAME} $*
1652 1561
1653 local want_source="$(java-pkg_get-source)" 1562 local want_source="$(java-pkg_get-source)"
1654 local want_target="$(java-pkg_get-target)" 1563 local want_target="$(java-pkg_get-target)"
1670 echo "${target_str}" 1579 echo "${target_str}"
1671 fi 1580 fi
1672 fi 1581 fi
1673} 1582}
1674 1583
1675# TODO document 1584# @FUNCTION: java-pkg_get-jni-cflags
1585# @DESCRIPTION:
1586# Echos the CFLAGS for JNI compilations
1676java-pkg_get-jni-cflags() { 1587java-pkg_get-jni-cflags() {
1677 local flags="-I${JAVA_HOME}/include" 1588 local flags="-I${JAVA_HOME}/include"
1678 1589
1679 local platform="linux" 1590 local platform="linux"
1680 use elibc_FreeBSD && platform="freebsd" 1591 use elibc_FreeBSD && platform="freebsd"
1684 1595
1685 echo ${flags} 1596 echo ${flags}
1686} 1597}
1687 1598
1688java-pkg_ensure-gcj() { 1599java-pkg_ensure-gcj() {
1689 if ! built_with_use sys-devel/gcc gcj ; then 1600 # was enforcing sys-devel/gcc[gcj]
1690 ewarn 1601 die "${FUNCNAME} was removed. Use use-deps available as of EAPI 2 instead. #261562"
1691 ewarn "You must build gcc with the gcj support to build with gcj"
1692 ewarn
1693 ebeep 5
1694 die "No GCJ support found!"
1695 fi
1696} 1602}
1697 1603
1698java-pkg_ensure-test() { 1604java-pkg_ensure-test() {
1699 if has test ${FEATURES} && ! has -test ${FEATURES} \ 1605 # was enforcing USE=test if FEATURES=test
1700 && has test ${IUSE} && ! use test; 1606 die "${FUNCNAME} was removed. Package mangers handle this already. #278965"
1701 then
1702 eerror "You specified FEATURES=test, but USE=test is needed"
1703 eerror "to pull in the additional dependencies for testing"
1704 die "Need USE=test enabled"
1705 fi
1706} 1607}
1707 1608
1708# ------------------------------------------------------------------------------ 1609# @FUNCTION: java-pkg_register-ant-task
1709# @ebuild-function java-pkg_register-ant-task 1610# @USAGE: [--version x.y] [<name>]
1710# 1611# @DESCRIPTION:
1711# 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
1712# 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
1713# 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
1714# 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
1715# .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
1716# compatibility. 1617# compatibility.
1717# 1618#
1619# @CODE
1620# Parameters
1718# @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
1719# version). Used by the ant-* packages to prevent loading of mismatched 1622# version). Used by the ant-* packages to prevent loading of mismatched
1720# 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,
1721# without a need for blockers. 1624# without a need for blockers.
1722# @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])
1723# ------------------------------------------------------------------------------ 1626# @CODE
1724java-pkg_register-ant-task() { 1627java-pkg_register-ant-task() {
1725 local TASKS_DIR="tasks" 1628 local TASKS_DIR="tasks"
1726 1629
1727 # check for --version x.y parameters 1630 # check for --version x.y parameters
1728 while [[ -n "${1}" && -n "${2}" ]]; do 1631 while [[ -n "${1}" && -n "${2}" ]]; do
1740 1643
1741 dodir /usr/share/ant/${TASKS_DIR} 1644 dodir /usr/share/ant/${TASKS_DIR}
1742 touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}" 1645 touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}"
1743} 1646}
1744 1647
1745# ------------------------------------------------------------------------------ 1648# @FUNCTION: java-pkg_ant-tasks-depend
1746# @internal-function java-pkg_ant-tasks-depend 1649# @INTERNAL
1747# 1650# @DESCRIPTION:
1748# Translates the WANT_ANT_TASKS variable into valid dependencies. 1651# Translates the WANT_ANT_TASKS variable into valid dependencies.
1749# ------------------------------------------------------------------------------
1750java-pkg_ant-tasks-depend() { 1652java-pkg_ant-tasks-depend() {
1751 debug-print-function ${FUNCNAME} ${WANT_ANT_TASKS} 1653 debug-print-function ${FUNCNAME} ${WANT_ANT_TASKS}
1752 1654
1753 if [[ -n "${WANT_ANT_TASKS}" ]]; then 1655 if [[ -n "${WANT_ANT_TASKS}" ]]; then
1754 local DEP="" 1656 local DEP=""
1769 return 0 1671 return 0
1770 fi 1672 fi
1771} 1673}
1772 1674
1773 1675
1774# ------------------------------------------------------------------------------ 1676# @FUNCTION: ejunit_
1775# @internal-function ejunit_ 1677# @INTERNAL
1776# 1678# @DESCRIPTION:
1777# Internal 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
1778# 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.
1779# 1681# @CODE
1682# Parameters:
1780# @param $1 - junit package (junit or junit-4) 1683# $1 - junit package (junit or junit-4)
1781# @param $2 - -cp or -classpath 1684# $2 - -cp or -classpath
1782# @param $3 - classpath; junit and recorded dependencies get appended 1685# $3 - classpath; junit and recorded dependencies get appended
1783# @param $@ - the rest of the parameters are passed to java 1686# $@ - the rest of the parameters are passed to java
1687# @CODE
1784ejunit_() { 1688ejunit_() {
1785 debug-print-function ${FUNCNAME} $* 1689 debug-print-function ${FUNCNAME} $*
1786 1690
1787 local pkgs 1691 local pkgs
1788 if [[ -f ${JAVA_PKG_DEPEND_FILE} ]]; then 1692 if [[ -f ${JAVA_PKG_DEPEND_FILE} ]]; then
1808 fi 1712 fi
1809 debug-print "Calling: java -cp \"${cp}\" -Djava.awt.headless=true ${runner} ${@}" 1713 debug-print "Calling: java -cp \"${cp}\" -Djava.awt.headless=true ${runner} ${@}"
1810 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"
1811} 1715}
1812 1716
1813# ------------------------------------------------------------------------------ 1717# @FUNCTION: ejunit
1814# @ebuild-function ejunit 1718# @DESCRIPTION:
1815#
1816# Junit wrapper function. Makes it easier to run the tests and checks for 1719# Junit wrapper function. Makes it easier to run the tests and checks for
1817# dev-java/junit in DEPEND. Launches the tests using org.junit.runner.JUnitCore. 1720# dev-java/junit in DEPEND. Launches the tests using org.junit.runner.JUnitCore.
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
1818# 1727#
1819# Examples: 1728# Examples:
1820# ejunit -cp build/classes org.blinkenlights.jid3.test.AllTests 1729# ejunit -cp build/classes org.blinkenlights.jid3.test.AllTests
1821# ejunit org.blinkenlights.jid3.test.AllTests 1730# ejunit org.blinkenlights.jid3.test.AllTests
1822# ejunit org.blinkenlights.jid3.test.FirstTest \ 1731# ejunit org.blinkenlights.jid3.test.FirstTest org.blinkenlights.jid3.test.SecondTest
1823# org.blinkenlights.jid3.test.SecondTest 1732# @CODE
1824#
1825# @param $1 - -cp or -classpath
1826# @param $2 - classpath; junit and recorded dependencies get appended
1827# @param $@ - the rest of the parameters are passed to java
1828# ------------------------------------------------------------------------------
1829ejunit() { 1733ejunit() {
1830 debug-print-function ${FUNCNAME} $* 1734 debug-print-function ${FUNCNAME} $*
1831 1735
1832 ejunit_ "junit" "${@}" 1736 ejunit_ "junit" "${@}"
1833} 1737}
1834 1738
1835# ------------------------------------------------------------------------------ 1739# @FUNCTION: ejunit4
1836# @ebuild-function ejunit4 1740# @DESCRIPTION:
1837#
1838# Junit4 wrapper function. Makes it easier to run the tests and checks for 1741# Junit4 wrapper function. Makes it easier to run the tests and checks for
1839# dev-java/junit:4 in DEPEND. Launches the tests using junit.textui.TestRunner. 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
1840# 1749#
1841# Examples: 1750# Examples:
1842# ejunit4 -cp build/classes org.blinkenlights.jid3.test.AllTests 1751# ejunit4 -cp build/classes org.blinkenlights.jid3.test.AllTests
1843# ejunit4 org.blinkenlights.jid3.test.AllTests 1752# ejunit4 org.blinkenlights.jid3.test.AllTests
1844# ejunit4 org.blinkenlights.jid3.test.FirstTest \ 1753# ejunit4 org.blinkenlights.jid3.test.FirstTest \
1845# org.blinkenlights.jid3.test.SecondTest 1754# org.blinkenlights.jid3.test.SecondTest
1846# 1755# @CODE
1847# @param $1 - -cp or -classpath
1848# @param $2 - classpath; junit and recorded dependencies get appended
1849# @param $@ - the rest of the parameters are passed to java
1850# ------------------------------------------------------------------------------
1851ejunit4() { 1756ejunit4() {
1852 debug-print-function ${FUNCNAME} $* 1757 debug-print-function ${FUNCNAME} $*
1853 1758
1854 ejunit_ "junit-4" "${@}" 1759 ejunit_ "junit-4" "${@}"
1855} 1760}
1856 1761
1857# ------------------------------------------------------------------------------ 1762# @FUNCTION: java-utils-2_src_prepare
1858# @section-end helper 1763# @DESCRIPTION:
1859# ------------------------------------------------------------------------------
1860
1861# ------------------------------------------------------------------------------
1862# @eclass-src_prepare
1863#
1864# src_prepare Searches for bundled jars 1764# src_prepare Searches for bundled jars
1865# Don't call directly, but via java-pkg-2_src_prepare! 1765# Don't call directly, but via java-pkg-2_src_prepare!
1866# ------------------------------------------------------------------------------
1867
1868java-utils-2_src_prepare() { 1766java-utils-2_src_prepare() {
1869 [[ ${EBUILD_PHASE} == prepare ]] && 1767 [[ ${EBUILD_PHASE} == prepare ]] &&
1870 java-pkg_func-exists java_prepare && java_prepare 1768 java-pkg_func-exists java_prepare && java_prepare
1871 1769
1872 # Remember that eant will call this unless called via Portage 1770 # Remember that eant will call this unless called via Portage
1878 echo "Search done." 1776 echo "Search done."
1879 fi 1777 fi
1880 touch "${T}/java-utils-2_src_prepare-run" 1778 touch "${T}/java-utils-2_src_prepare-run"
1881} 1779}
1882 1780
1883# ------------------------------------------------------------------------------ 1781# @FUNCTION: java-utils-2_pkg_preinst
1884# @eclass-pkg_preinst 1782# @DESCRIPTION:
1885#
1886# pkg_preinst Searches for missing and unneeded dependencies 1783# pkg_preinst Searches for missing and unneeded dependencies
1887# Don't call directly, but via java-pkg-2_pkg_preinst! 1784# Don't call directly, but via java-pkg-2_pkg_preinst!
1888# ------------------------------------------------------------------------------
1889
1890java-utils-2_pkg_preinst() { 1785java-utils-2_pkg_preinst() {
1891 if is-java-strict; then 1786 if is-java-strict; then
1892 if has_version dev-java/java-dep-check; then 1787 if has_version dev-java/java-dep-check; then
1893 [[ -e "${JAVA_PKG_ENV}" ]] || return 1788 [[ -e "${JAVA_PKG_ENV}" ]] || return
1894 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}")
1905 eerror "Install dev-java/java-dep-check for dependency checking" 1800 eerror "Install dev-java/java-dep-check for dependency checking"
1906 fi 1801 fi
1907 fi 1802 fi
1908} 1803}
1909 1804
1910# ------------------------------------------------------------------------------ 1805# @FUNCTION: eant
1911# @section-begin build 1806# @USAGE: <ant_build_target(s)>
1912# @section-summary Build functions 1807# @DESCRIPTION:
1913#
1914# These are some functions for building a package. In particular, it consists of
1915# wrappers for javac and ant.
1916# ------------------------------------------------------------------------------
1917
1918# ------------------------------------------------------------------------------
1919# @ebuild-function eant
1920#
1921# 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
1922# 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,
1923# variables: 1810# variables:
1811#
1812# @CODE
1813# Variables:
1924# 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
1925# gentoo.classpath property. Be sure to call 1815# gentoo.classpath property. Be sure to call java-ant_rewrite-classpath in src_unpack.
1926# java-ant_rewrite-classpath in src_unpack.
1927# 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
1928# for build-time purposes, the dependency is not recorded to 1817# for build-time purposes, the dependency is not recorded to
1929# package.env! 1818# package.env!
1930# *ANT_TASKS - used to determine ANT_TASKS before calling Ant. 1819# ANT_TASKS - used to determine ANT_TASKS before calling Ant.
1931# ------------------------------------------------------------------------------ 1820# @CODE
1932eant() { 1821eant() {
1933 debug-print-function ${FUNCNAME} $* 1822 debug-print-function ${FUNCNAME} $*
1934 1823
1935 if [[ ${EBUILD_PHASE} = compile ]]; then 1824 if [[ ${EBUILD_PHASE} = compile ]]; then
1936 java-ant-2_src_configure 1825 java-ant-2_src_configure
2045 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}" 1934 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}"
2046 debug-print "Calling ant (GENTOO_VM: ${GENTOO_VM}): ${antflags} ${@}" 1935 debug-print "Calling ant (GENTOO_VM: ${GENTOO_VM}): ${antflags} ${@}"
2047 ant ${antflags} "${@}" || die "eant failed" 1936 ant ${antflags} "${@}" || die "eant failed"
2048} 1937}
2049 1938
2050# ------------------------------------------------------------------------------ 1939# @FUNCTION: ejavac
2051# @ebuild-function ejavac 1940# @USAGE: <javac_arguments>
2052# 1941# @DESCRIPTION:
2053# Javac wrapper function. Will use the appropriate compiler, based on 1942# Javac wrapper function. Will use the appropriate compiler, based on
2054# /etc/java-config/compilers.conf 1943# /etc/java-config/compilers.conf
2055#
2056# @param $@ - Arguments to be passed to the compiler
2057# ------------------------------------------------------------------------------
2058ejavac() { 1944ejavac() {
2059 debug-print-function ${FUNCNAME} $* 1945 debug-print-function ${FUNCNAME} $*
2060 1946
2061 java-pkg_init-compiler_ 1947 java-pkg_init-compiler_
2062 1948
2076 1962
2077 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} ${javac_args} "${@}" 1963 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} ${javac_args} "${@}"
2078 ${compiler_executable} ${javac_args} "${@}" || die "ejavac failed" 1964 ${compiler_executable} ${javac_args} "${@}" || die "ejavac failed"
2079} 1965}
2080 1966
2081# ------------------------------------------------------------------------------ 1967# @FUNCTION: ejavadoc
2082# @ebuild-function java-pkg_filter-compiler 1968# @USAGE: <javadoc_arguments>
2083# 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:
2084# 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.
2085# Basically, it just appends onto JAVA_PKG_FILTER_COMPILER 1988# Basically, it just appends onto JAVA_PKG_FILTER_COMPILER
2086#
2087# @param $@ - compilers to filter
2088# ------------------------------------------------------------------------------
2089java-pkg_filter-compiler() { 1989java-pkg_filter-compiler() {
2090 JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@" 1990 JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@"
2091} 1991}
2092 1992
2093# ------------------------------------------------------------------------------ 1993# @FUNCTION: java-pkg_force-compiler
2094# @ebuild-function java-pkg_force-compiler 1994# @USAGE: <compiler(s)_to_force>
2095# 1995# @DESCRIPTION:
2096# 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.
2097# 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
2098# OutOfMemoryErrors that may come up. 1998# OutOfMemoryErrors that may come up.
2099#
2100# @param $@ - compilers to force
2101# ------------------------------------------------------------------------------
2102java-pkg_force-compiler() { 1999java-pkg_force-compiler() {
2103 JAVA_PKG_FORCE_COMPILER="$@" 2000 JAVA_PKG_FORCE_COMPILER="$@"
2104} 2001}
2105 2002
2106# ------------------------------------------------------------------------------ 2003# @FUNCTION: use_doc
2107# @ebuild-function use_doc 2004# @DESCRIPTION:
2108# 2005#
2109# 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,
2110# 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.
2111# 2008#
2112# 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'
2113# 2013#
2014# Examples:
2114# Example: build javadocs by calling 'javadoc' target 2015# build javadocs by calling 'javadoc' target
2115# eant $(use_doc) 2016# eant $(use_doc)
2017#
2116# Example: build javadocs by calling 'apidoc' target 2018# build javadocs by calling 'apidoc' target
2117# eant $(use_doc apidoc) 2019# eant $(use_doc apidoc)
2118# 2020# @CODE
2119# @param $@ - Option value to return. Defaults to 'javadoc'
2120# @return string - Name of the target to create javadocs 2021# @RETURN string - Name of the target to create javadocs
2121# ------------------------------------------------------------------------------
2122use_doc() { 2022use_doc() {
2123 use doc && echo ${@:-javadoc} 2023 use doc && echo ${@:-javadoc}
2124} 2024}
2125 2025
2126 2026
2127# ------------------------------------------------------------------------------ 2027# @FUNCTION: java-pkg_init
2128# @section-end build 2028# @INTERNAL
2129# ------------------------------------------------------------------------------ 2029# @DESCRIPTION:
2130
2131# ------------------------------------------------------------------------------
2132# @section-begin internal
2133# @section-summary Internal functions
2134#
2135# Do __NOT__ use any of these from an ebuild! These are only to be used from
2136# within the java eclasses.
2137# ------------------------------------------------------------------------------
2138
2139# -----------------------------------------------------------------------------
2140# @function-internal java-pkg_init
2141#
2142# 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
2143# 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
2144# 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
2145# internally. And most importantly, it'll switch the VM if necessary. 2033# internally. And most importantly, it'll switch the VM if necessary.
2146# 2034#
2147# 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
2148# call it during each of the phases of the merge process. 2036# call it during each of the phases of the merge process.
2149#
2150# -----------------------------------------------------------------------------
2151java-pkg_init() { 2037java-pkg_init() {
2152 debug-print-function ${FUNCNAME} $* 2038 debug-print-function ${FUNCNAME} $*
2153 2039
2154 # Don't set up build environment if installing from binary. #206024 #258423 2040 # Don't set up build environment if installing from binary. #206024 #258423
2155 [[ "${MERGE_TYPE}" == "binary" ]] && return 2041 [[ "${MERGE_TYPE}" == "binary" ]] && return
2191 2077
2192 if java-pkg_func-exists ant_src_unpack; then 2078 if java-pkg_func-exists ant_src_unpack; then
2193 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"
2194 fi 2080 fi
2195 2081
2196 java-pkg_init_paths_
2197 java-pkg_switch-vm 2082 java-pkg_switch-vm
2198 PATH=${JAVA_HOME}/bin:${PATH} 2083 PATH=${JAVA_HOME}/bin:${PATH}
2199 2084
2200 # TODO we will probably want to set JAVAC and JAVACFLAGS 2085 # TODO we will probably want to set JAVAC and JAVACFLAGS
2201 2086
2215 export ANT_TASKS= 2100 export ANT_TASKS=
2216 export ANT_OPTS= 2101 export ANT_OPTS=
2217 export ANT_RESPECT_JAVA_HOME= 2102 export ANT_RESPECT_JAVA_HOME=
2218} 2103}
2219 2104
2220# ------------------------------------------------------------------------------ 2105# @FUNCTION: java-pkg-init-compiler_
2221# @function-internal java-pkg-init-compiler_ 2106# @INTERNAL
2222# 2107# @DESCRIPTION:
2223# 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
2224# 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
2225# COMPILERS variable defined there. 2110# COMPILERS variable defined there.
2226# 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
2227# 2112#
2238# 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
2239# 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
2240# by the current VM. 2125# by the current VM.
2241# 2126#
2242# 2127#
2243# @return name of the compiler to use 2128# @RETURN name of the compiler to use
2244# ------------------------------------------------------------------------------
2245java-pkg_init-compiler_() { 2129java-pkg_init-compiler_() {
2246 debug-print-function ${FUNCNAME} $* 2130 debug-print-function ${FUNCNAME} $*
2247 2131
2248 if [[ -n ${GENTOO_COMPILER} ]]; then 2132 if [[ -n ${GENTOO_COMPILER} ]]; then
2249 debug-print "GENTOO_COMPILER already set" 2133 debug-print "GENTOO_COMPILER already set"
2329 einfo "Using ${GENTOO_COMPILER} for compilation" 2213 einfo "Using ${GENTOO_COMPILER} for compilation"
2330 fi 2214 fi
2331 2215
2332} 2216}
2333 2217
2334# ------------------------------------------------------------------------------ 2218# @FUNCTION: init_paths_
2335# @internal-function init_paths_ 2219# @INTERNAL
2336# 2220# @DESCRIPTION:
2337# 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
2338# to determine where things will eventually get installed. 2222# to determine where things will eventually get installed.
2339# ------------------------------------------------------------------------------
2340java-pkg_init_paths_() { 2223java-pkg_init_paths_() {
2341 debug-print-function ${FUNCNAME} $* 2224 debug-print-function ${FUNCNAME} $*
2342 2225
2343 local pkg_name 2226 local pkg_name
2344 if [[ "$SLOT" == "0" ]] ; then 2227 if [[ "${SLOT%/*}" == "0" ]] ; then
2345 JAVA_PKG_NAME="${PN}" 2228 JAVA_PKG_NAME="${PN}"
2346 else 2229 else
2347 JAVA_PKG_NAME="${PN}-${SLOT}" 2230 JAVA_PKG_NAME="${PN}-${SLOT%/*}"
2348 fi 2231 fi
2349 2232
2350 JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}" 2233 JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}"
2351 JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/" 2234 JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/"
2352 JAVA_PKG_ENV="${D}${JAVA_PKG_SHAREPATH}/package.env" 2235 JAVA_PKG_ENV="${D}${JAVA_PKG_SHAREPATH}/package.env"
2354 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}"
2355 2238
2356 [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib" 2239 [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib"
2357 [[ -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}"
2358 [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps" 2241 [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps"
2359
2360 2242
2361 # TODO maybe only print once? 2243 # TODO maybe only print once?
2362 debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}" 2244 debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}"
2363 debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}" 2245 debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}"
2364 debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}" 2246 debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}"
2365 debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}" 2247 debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}"
2366 debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}" 2248 debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}"
2367} 2249}
2368 2250
2369# ------------------------------------------------------------------------------ 2251# @FUNCTION: java-pkg_do_write_
2370# @internal-function java-pkg_do_write_ 2252# @INTERNAL
2371# 2253# @DESCRIPTION:
2372# Writes the package.env out to disk. 2254# Writes the package.env out to disk.
2373# 2255#
2374# ------------------------------------------------------------------------------
2375# TODO change to do-write, to match everything else 2256# TODO change to do-write, to match everything else
2376java-pkg_do_write_() { 2257java-pkg_do_write_() {
2377 debug-print-function ${FUNCNAME} $* 2258 debug-print-function ${FUNCNAME} $*
2378 java-pkg_init_paths_ 2259 java-pkg_init_paths_
2379 # Create directory for package.env 2260 # Create directory for package.env
2434 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"
2435 debug-print "write package.env." 2316 debug-print "write package.env."
2436 fi 2317 fi
2437} 2318}
2438 2319
2439# ------------------------------------------------------------------------------ 2320# @FUNCTION: java-pkg_record-jar_
2440# @internal-function java-pkg_record-jar_ 2321# @INTERNAL
2441# 2322# @DESCRIPTION:
2442# Record an (optional) dependency to the package.env 2323# Record an (optional) dependency to the package.env
2324# @CODE
2325# Parameters:
2443# @param --optional - record dependency as optional 2326# --optional - record dependency as optional
2444# @param --build - record dependency as build_only 2327# --build - record dependency as build_only
2445# @param $1 - package to record 2328# $1 - package to record
2446# @param $2 - (optional) jar of package to record 2329# $2 - (optional) jar of package to record
2447# ------------------------------------------------------------------------------ 2330# @CODE
2448JAVA_PKG_DEPEND_FILE="${T}/java-pkg-depend" 2331JAVA_PKG_DEPEND_FILE="${T}/java-pkg-depend"
2449JAVA_PKG_OPTIONAL_DEPEND_FILE="${T}/java-pkg-optional-depend" 2332JAVA_PKG_OPTIONAL_DEPEND_FILE="${T}/java-pkg-optional-depend"
2450JAVA_PKG_BUILD_DEPEND_FILE="${T}/java-pkg-build-depend" 2333JAVA_PKG_BUILD_DEPEND_FILE="${T}/java-pkg-build-depend"
2451 2334
2452java-pkg_record-jar_() { 2335java-pkg_record-jar_() {
2466 fi 2349 fi
2467 2350
2468 echo "${append}" >> "${depend_file}" 2351 echo "${append}" >> "${depend_file}"
2469} 2352}
2470 2353
2471# ------------------------------------------------------------------------------ 2354# @FUNCTION: java-pkg_append_
2472# @internal-function java-pkg_append_ 2355# @INTERNAL
2473# 2356# @DESCRIPTION:
2474# Appends a value to a variable 2357# Appends a value to a variable
2475# 2358#
2476# Example: java-pkg_append_ CLASSPATH foo.jar 2359# @CODE
2360# Parameters:
2477# @param $1 variable name to modify 2361# $1 variable name to modify
2478# @param $2 value to append 2362# $2 value to append
2479# ------------------------------------------------------------------------------ 2363#
2364# Examples:
2365# java-pkg_append_ CLASSPATH foo.jar
2366# @CODE
2480java-pkg_append_() { 2367java-pkg_append_() {
2481 debug-print-function ${FUNCNAME} $* 2368 debug-print-function ${FUNCNAME} $*
2482 2369
2483 local var="${1}" value="${2}" 2370 local var="${1}" value="${2}"
2484 if [[ -z "${!var}" ]] ; then 2371 if [[ -z "${!var}" ]] ; then
2495 [[ -z ${haveit} ]] && export ${var}="${!var}:${value}" 2382 [[ -z ${haveit} ]] && export ${var}="${!var}:${value}"
2496 IFS=${oldIFS} 2383 IFS=${oldIFS}
2497 fi 2384 fi
2498} 2385}
2499 2386
2500# ------------------------------------------------------------------------------ 2387# @FUNCTION: java-pkg_expand_dir_
2501# @internal-function java-pkg_expand_dir_ 2388# @INTERNAL
2502# 2389# @DESCRIPTION:
2503# 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:
2504# @param $1 - file/directory to find parent directory for 2393# $1 - file/directory to find parent directory for
2394# @CODE
2505# @return - path to $1's parent directory 2395# @RETURN: path to $1's parent directory
2506# ------------------------------------------------------------------------------
2507java-pkg_expand_dir_() { 2396java-pkg_expand_dir_() {
2508 pushd "$(dirname "${1}")" >/dev/null 2>&1 2397 pushd "$(dirname "${1}")" >/dev/null 2>&1
2509 pwd 2398 pwd
2510 popd >/dev/null 2>&1 2399 popd >/dev/null 2>&1
2511} 2400}
2512 2401
2513# ------------------------------------------------------------------------------ 2402# @FUNCTION: java-pkg_func-exists
2514# @internal-function java-pkg_func-exists 2403# @INTERNAL
2515# 2404# @DESCRIPTION:
2516# Does the indicated function exist? 2405# Does the indicated function exist?
2517# 2406# @RETURN: 0 - function is declared, 1 - function is undeclared
2518# @return 0 - function is declared
2519# @return 1 - function is undeclared
2520# ------------------------------------------------------------------------------
2521java-pkg_func-exists() { 2407java-pkg_func-exists() {
2522 declare -F ${1} > /dev/null 2408 declare -F ${1} > /dev/null
2523} 2409}
2524 2410
2525# ------------------------------------------------------------------------------ 2411# @FUNCTION: java-pkg_setup-vm
2526# @internal-function java-pkg_setup-vm 2412# @INTERNAL
2527# 2413# @DESCRIPTION:
2528# Sets up the environment for a specific VM 2414# Sets up the environment for a specific VM
2529#
2530# ------------------------------------------------------------------------------
2531java-pkg_setup-vm() { 2415java-pkg_setup-vm() {
2532 debug-print-function ${FUNCNAME} $* 2416 debug-print-function ${FUNCNAME} $*
2533 2417
2534 local vendor="$(java-pkg_get-vm-vendor)" 2418 local vendor="$(java-pkg_get-vm-vendor)"
2535 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
2547 elif [[ "${vendor}" == "jrockit" ]]; then 2431 elif [[ "${vendor}" == "jrockit" ]]; then
2548 addpredict "/proc/cpuinfo" 2432 addpredict "/proc/cpuinfo"
2549 fi 2433 fi
2550} 2434}
2551 2435
2552# ------------------------------------------------------------------------------ 2436# @FUNCTION: java-pkg_needs-vm
2553# @internal-function java-pkg_needs-vm 2437# @INTERNAL
2554# 2438# @DESCRIPTION:
2555# Does the current package depend on virtual/jdk or does it set 2439# Does the current package depend on virtual/jdk or does it set
2556# JAVA_PKG_WANT_BUILD_VM? 2440# JAVA_PKG_WANT_BUILD_VM?
2557# 2441#
2558# @return 0 - Package depends on virtual/jdk 2442# @RETURN: 0 - Package depends on virtual/jdk; 1 - Package does not depend on virtual/jdk
2559# @return 1 - Package does not depend on virtual/jdk
2560# ------------------------------------------------------------------------------
2561java-pkg_needs-vm() { 2443java-pkg_needs-vm() {
2562 debug-print-function ${FUNCNAME} $* 2444 debug-print-function ${FUNCNAME} $*
2563 2445
2564 if [[ -n "$(echo ${JAVA_PKG_NV_DEPEND:-${DEPEND}} | sed -e '\:virtual/jdk:!d')" ]]; then 2446 if [[ -n "$(echo ${JAVA_PKG_NV_DEPEND:-${DEPEND}} | sed -e '\:virtual/jdk:!d')" ]]; then
2565 return 0 2447 return 0
2568 [[ -n "${JAVA_PKG_WANT_BUILD_VM}" ]] && return 0 2450 [[ -n "${JAVA_PKG_WANT_BUILD_VM}" ]] && return 0
2569 2451
2570 return 1 2452 return 1
2571} 2453}
2572 2454
2573# ------------------------------------------------------------------------------ 2455# @FUNCTION: java-pkg_get-current-vm
2574# @internal-function java-pkg_get-current-vm 2456# @INTERNAL
2575#
2576# @return - The current VM being used 2457# @RETURN - The current VM being used
2577# ------------------------------------------------------------------------------
2578java-pkg_get-current-vm() { 2458java-pkg_get-current-vm() {
2579 java-config -f 2459 java-config -f
2580} 2460}
2581 2461
2582# ------------------------------------------------------------------------------ 2462# @FUNCTION: java-pkg_get-vm-vendor
2583# @internal-function java-pkg_get-vm-vendor 2463# @INTERNAL
2584#
2585# @return - The vendor of the current VM 2464# @RETURN - The vendor of the current VM
2586# ------------------------------------------------------------------------------
2587java-pkg_get-vm-vendor() { 2465java-pkg_get-vm-vendor() {
2588 debug-print-function ${FUNCNAME} $* 2466 debug-print-function ${FUNCNAME} $*
2589 2467
2590 local vm="$(java-pkg_get-current-vm)" 2468 local vm="$(java-pkg_get-current-vm)"
2591 vm="${vm/-*/}" 2469 vm="${vm/-*/}"
2592 echo "${vm}" 2470 echo "${vm}"
2593} 2471}
2594 2472
2595# ------------------------------------------------------------------------------ 2473# @FUNCTION: java-pkg_get-vm-version
2596# @internal-function java-pkg_get-vm-version 2474# @INTERNAL
2597#
2598# @return - The version of the current VM 2475# @RETURN - The version of the current VM
2599# ------------------------------------------------------------------------------
2600java-pkg_get-vm-version() { 2476java-pkg_get-vm-version() {
2601 debug-print-function ${FUNCNAME} $* 2477 debug-print-function ${FUNCNAME} $*
2602 2478
2603 java-config -g PROVIDES_VERSION 2479 java-config -g PROVIDES_VERSION
2604} 2480}
2605 2481
2606# ------------------------------------------------------------------------------ 2482# @FUNCTION: java-pkg_build-vm-from-handle
2607# @internal-function java-pkg_build-vm-from-handle 2483# @INTERNAL
2608# 2484# @DESCRIPTION:
2609# Selects a build vm from a list of vm handles. First checks for the system-vm 2485# Selects a build vm from a list of vm handles. First checks for the system-vm
2610# beeing usable, then steps through the listed handles till a suitable vm is 2486# beeing usable, then steps through the listed handles till a suitable vm is
2611# found. 2487# found.
2612# 2488#
2613# @return - VM handle of an available JDK 2489# @RETURN - VM handle of an available JDK
2614# ------------------------------------------------------------------------------
2615java-pkg_build-vm-from-handle() { 2490java-pkg_build-vm-from-handle() {
2616 debug-print-function ${FUNCNAME} "$*" 2491 debug-print-function ${FUNCNAME} "$*"
2617 2492
2618 local vm 2493 local vm
2619 vm=$(java-pkg_get-current-vm) 2494 vm=$(java-pkg_get-current-vm 2>/dev/null)
2620 if [[ $? != 0 ]]; then 2495 if [[ $? -eq 0 ]]; then
2621 eerror "${FUNCNAME}: Failed to get active vm"
2622 return 1
2623 fi
2624
2625 if has ${vm} ${JAVA_PKG_WANT_BUILD_VM}; then 2496 if has ${vm} ${JAVA_PKG_WANT_BUILD_VM}; then
2626 echo ${vm} 2497 echo ${vm}
2627 return 0 2498 return 0
2499 fi
2628 fi 2500 fi
2629 2501
2630 for vm in ${JAVA_PKG_WANT_BUILD_VM}; do 2502 for vm in ${JAVA_PKG_WANT_BUILD_VM}; do
2631 if java-config-2 --select-vm=${vm} 2>/dev/null; then 2503 if java-config-2 --select-vm=${vm} 2>/dev/null; then
2632 echo ${vm} 2504 echo ${vm}
2636 2508
2637 eerror "${FUNCNAME}: No vm found for handles: ${JAVA_PKG_WANT_BUILD_VM}" 2509 eerror "${FUNCNAME}: No vm found for handles: ${JAVA_PKG_WANT_BUILD_VM}"
2638 return 1 2510 return 1
2639} 2511}
2640 2512
2641# ------------------------------------------------------------------------------ 2513# @FUNCTION: java-pkg_switch-vm
2642# @internal-function java-pkg_switch-vm 2514# @INTERNAL
2643# 2515# @DESCRIPTION:
2644# 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
2645# verify that the current VM is sufficient. 2517# verify that the current VM is sufficient.
2646# Setup the environment for the VM being used. 2518# Setup the environment for the VM being used.
2647# ------------------------------------------------------------------------------
2648java-pkg_switch-vm() { 2519java-pkg_switch-vm() {
2649 debug-print-function ${FUNCNAME} $* 2520 debug-print-function ${FUNCNAME} $*
2650 2521
2651 if java-pkg_needs-vm; then 2522 if java-pkg_needs-vm; then
2652 # Use the VM specified by JAVA_PKG_FORCE_VM 2523 # Use the VM specified by JAVA_PKG_FORCE_VM
2720 else 2591 else
2721 [[ -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!!!"
2722 fi 2593 fi
2723} 2594}
2724 2595
2725# ------------------------------------------------------------------------------ 2596# @FUNCTION: java-pkg_die
2726# @internal-function java-pkg_die 2597# @INTERNAL
2727# 2598# @DESCRIPTION:
2728# 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
2729# useful for debugging bugs on bugzilla. 2600# useful for debugging bugs on bugzilla.
2730# ------------------------------------------------------------------------------
2731#register_die_hook java-pkg_die 2601#register_die_hook java-pkg_die
2732if ! has java-pkg_die ${EBUILD_DEATH_HOOKS}; then 2602if ! has java-pkg_die ${EBUILD_DEATH_HOOKS}; then
2733 EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die" 2603 EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die"
2734fi 2604fi
2735 2605
2736java-pkg_die() { 2606java-pkg_die() {
2737 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
2738 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
2739 echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2 2609 echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2
2740 echo "and of course, the output of emerge --info" >&2 2610 echo "and of course, the output of emerge --info =${P}" >&2
2741} 2611}
2742 2612
2743 2613
2744# TODO document 2614# TODO document
2745# List jars in the source directory, ${S} 2615# List jars in the source directory, ${S}
2752 einfo "Classes" 2622 einfo "Classes"
2753 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},"
2754 fi 2624 fi
2755} 2625}
2756 2626
2757# ------------------------------------------------------------------------------ 2627# @FUNCTION: java-pkg_verify-classes
2758# @internal-function java-pkg_verify-classes 2628# @INTERNAL
2759# 2629# @DESCRIPTION:
2760# 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
2761# not. 2631# not.
2632# @CODE
2762# @param $1 (optional) - the file to check, otherwise checks whole ${D} 2633# $1 (optional) - the file to check, otherwise checks whole ${D}
2763# ------------------------------------------------------------------------------ 2634# @CODE
2764java-pkg_verify-classes() { 2635java-pkg_verify-classes() {
2765 #$(find ${D} -type f -name '*.jar' -o -name '*.class') 2636 #$(find ${D} -type f -name '*.jar' -o -name '*.class')
2766 2637
2767 local version_verify="/usr/bin/class-version-verify.py" 2638 local version_verify="/usr/bin/class-version-verify.py"
2768 2639
2796 eerror "See ${log} for more details." 2667 eerror "See ${log} for more details."
2797 die "Incorrect bytecode found" 2668 die "Incorrect bytecode found"
2798 fi 2669 fi
2799} 2670}
2800 2671
2801# ---------------------------------------------------------------------------- 2672# @FUNCTION: java-pkg_ensure-dep
2802# @internal-function java-pkg_ensure-dep 2673# @INTERNAL
2674# @DESCRIPTION:
2803# 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
2804# within DEPEND or RDEPEND. 2676# within DEPEND or RDEPEND.
2677# @CODE
2678# Parameters:
2805# @param $1 - empty - check both vars; "runtime" or "build" - check only 2679# $1 - empty - check both vars; "runtime" or "build" - check only
2806# RDEPEND, resp. DEPEND 2680# RDEPEND, resp. DEPEND
2807# @param $2 - Package name and slot. 2681# $2 - Package name and slot.
2808 2682# @CODE
2809java-pkg_ensure-dep() { 2683java-pkg_ensure-dep() {
2810 debug-print-function ${FUNCNAME} $* 2684 debug-print-function ${FUNCNAME} $*
2811 2685
2812 local limit_to="${1}" 2686 local limit_to="${1}"
2813 local target_pkg="${2}" 2687 local target_pkg="${2}"
2851 fi 2725 fi
2852 fi 2726 fi
2853 fi 2727 fi
2854} 2728}
2855 2729
2856# ------------------------------------------------------------------------------
2857# @section-end internal
2858# ------------------------------------------------------------------------------
2859
2860java-pkg_check-phase() { 2730java-pkg_check-phase() {
2861 local phase=${1} 2731 local phase=${1}
2862 local funcname=${FUNCNAME[1]} 2732 local funcname=${FUNCNAME[1]}
2863 if [[ ${EBUILD_PHASE} != ${phase} ]]; then 2733 if [[ ${EBUILD_PHASE} != ${phase} ]]; then
2864 local msg="${funcname} used outside of src_${phase}" 2734 local msg="${funcname} used outside of src_${phase}"
2898 2768
2899is-java-strict() { 2769is-java-strict() {
2900 [[ -n ${JAVA_PKG_STRICT} ]] 2770 [[ -n ${JAVA_PKG_STRICT} ]]
2901 return $? 2771 return $?
2902} 2772}
2903
2904
2905# ------------------------------------------------------------------------------
2906# @eclass-end
2907# ------------------------------------------------------------------------------

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

  ViewVC Help
Powered by ViewVC 1.1.20