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

Legend:
Removed from v.1.38  
changed lines
  Added in v.1.158

  ViewVC Help
Powered by ViewVC 1.1.20