/[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.3 Revision 1.157
1# Base eclass for Java packages 1# Base eclass for Java packages
2# 2#
3# Copyright (c) 2004-2005, Thomas Matthijs <axxo@gentoo.org> 3# Copyright (c) 2004-2005, Thomas Matthijs <axxo@gentoo.org>
4# Copyright (c) 2004, Karl Trygve Kalleberg <karltk@gentoo.org> 4# Copyright (c) 2004, Karl Trygve Kalleberg <karltk@gentoo.org>
5# Copyright (c) 2004-2005, Gentoo Foundation 5# Copyright (c) 2004-2011, Gentoo Foundation
6# 6#
7# Licensed under the GNU General Public License, v2 7# Licensed under the GNU General Public License, v2
8# 8#
9# $Header: /var/cvsroot/gentoo-x86/eclass/java-utils-2.eclass,v 1.157 2015/04/04 21:04:49 chewi Exp $
9 10
10 11# @ECLASS: java-utils-2.eclass
11# ----------------------------------------------------------------------------- 12# @MAINTAINER:
12# @eclass-begin 13# java@gentoo.org
13# @eclass-shortdesc Java Utility eclass 14# @AUTHOR:
14# @eclass-maintainer java@gentoo.org 15# Thomas Matthijs <axxo@gentoo.org>, Karl Trygve Kalleberg <karltk@gentoo.org>
15# 16# @BLURB: Base eclass for Java packages
17# @DESCRIPTION:
16# This eclass provides functionality which is used by 18# This eclass provides functionality which is used by java-pkg-2.eclass,
17# java-pkg.eclass and java-pkg-opt.eclass as well as from ebuilds. 19# java-pkg-opt-2.eclass and java-ant-2 eclass, as well as from ebuilds.
18# 20#
19# @warning 21# This eclass should not be inherited this directly from an ebuild. Instead,
20# You probably don't want to inherit this directly from an ebuild. Instead, 22# you should inherit java-pkg-2 for Java packages or java-pkg-opt-2 for packages
21# you should inherit java-ant for Ant-based Java packages, java-pkg for other 23# that have optional Java support. In addition you can inherit java-ant-2 for
22# Java packages, or java-pkg-opt for packages that have optional Java support. 24# Ant-based packages.
23#
24# -----------------------------------------------------------------------------
25
26inherit eutils versionator multilib 25inherit eutils versionator multilib
27 26
28# ----------------------------------------------------------------------------- 27IUSE="elibc_FreeBSD"
29# @section-begin variables
30# @section-title Variables
31#
32# Summary of variables which control the behavior of building Java packges.
33# -----------------------------------------------------------------------------
34 28
35# Make sure we use java-config-2 29# Make sure we use java-config-2
36export WANT_JAVA_CONFIG="2" 30export WANT_JAVA_CONFIG="2"
37 31
38# ----------------------------------------------------------------------------- 32# @VARIABLE: JAVA_PKG_PORTAGE_DEP
39# @variable-internal JAVA_PKG_E_DEPEND 33# @INTERNAL
40# 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.
38has "${EAPI}" 0 1 && JAVA_PKG_PORTAGE_DEP=">=sys-apps/portage-2.1.2.7"
39
40# @VARIABLE: JAVA_PKG_E_DEPEND
41# @INTERNAL
42# @DESCRIPTION:
41# 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
42# 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
43# portage, that includes phase hooks. 45# so that ebuilds can use new features without depending on specific versions.
44# ----------------------------------------------------------------------------- 46JAVA_PKG_E_DEPEND=">=dev-java/java-config-2.1.9-r1 ${JAVA_PKG_PORTAGE_DEP}"
45JAVA_PKG_E_DEPEND=">=dev-java/java-config-2.0.19-r1 >=sys-apps/portage-2.1_pre1" 47has source ${JAVA_PKG_IUSE} && JAVA_PKG_E_DEPEND="${JAVA_PKG_E_DEPEND} source? ( app-arch/zip )"
46 48
47# ----------------------------------------------------------------------------- 49# @ECLASS-VARIABLE: JAVA_PKG_WANT_BOOTCLASSPATH
48# @variable-external JAVA_PKG_ALLOW_VM_CHANGE 50# @DEFAULT_UNSET
49# @variable-default yes 51# @DESCRIPTION:
50# 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:
51# Allow this eclass to change the active VM? 66# Allow this eclass to change the active VM?
52# 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
53# @note This is useful for testing specific VMs. 68# instead of trying to switch to another VM.
54# ----------------------------------------------------------------------------- 69#
70# Overriding the default can be useful for testing specific VMs locally, but
71# should not be used in the final ebuild.
55JAVA_PKG_ALLOW_VM_CHANGE=${JAVA_PKG_ALLOW_VM_CHANGE:="yes"} 72JAVA_PKG_ALLOW_VM_CHANGE=${JAVA_PKG_ALLOW_VM_CHANGE:="yes"}
56 73
57# ----------------------------------------------------------------------------- 74# @ECLASS-VARIABLE: JAVA_PKG_FORCE_VM
58# @variable-external JAVA_PKG_FORCE_VM 75# @DEFAULT_UNSET
59# 76# @DESCRIPTION:
60# 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
61# 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.
62# 79#
63# Should only be used for testing and debugging. 80# Should only be used for testing and debugging.
64# 81#
65# @example Use sun-jdk-1.5 to emerge foo 82# Example: use sun-jdk-1.5 to emerge foo:
83# @CODE
66# JAVA_PKG_FORCE_VM=sun-jdk-1.5 emerge foo 84# JAVA_PKG_FORCE_VM=sun-jdk-1.5 emerge foo
67# 85# @CODE
68# -----------------------------------------------------------------------------
69 86
70# ----------------------------------------------------------------------------- 87# @ECLASS-VARIABLE: JAVA_PKG_WANT_BUILD_VM
71# @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.
72# 93#
73# 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.
74# 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.
75# See java-pkg_get-source function below. 105# See java-pkg_get-source function below.
76# 106#
77# Should only be used for testing and debugging. 107# Should generally only be used for testing and debugging.
78# 108#
79# @seealso java-pkg_get-source
80#
81# @example Use 1.4 source to emerge baz 109# Use 1.4 source to emerge baz
110# @CODE
82# JAVA_PKG_WANT_SOURCE=1.4 emerge baz 111# JAVA_PKG_WANT_SOURCE=1.4 emerge baz
83# ----------------------------------------------------------------------------- 112# @CODE
84 113
85# ----------------------------------------------------------------------------- 114# @ECLASS-VARIABLE: JAVA_PKG_WANT_TARGET
86# @variable-external JAVA_PKG_WANT_TARGET 115# @DEFAULT_UNSET
87# 116# @DESCRIPTION:
88# 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.
89# See java-pkg_get-target function below. 120# See java-pkg_get-target function below.
90# 121#
91# Should only be used for testing and debugging. 122# Should generallyonly be used for testing and debugging.
92# 123#
93# @seealso java-pkg_get-target
94#
95# @example emerge bar to be compatible with 1.3 124# emerge bar to be compatible with 1.3
125# @CODE
96# JAVA_PKG_WANT_TARGET=1.3 emerge bar 126# JAVA_PKG_WANT_TARGET=1.3 emerge bar
97# ----------------------------------------------------------------------------- 127# @CODE
98 128
99# ----------------------------------------------------------------------------- 129# @VARIABLE: JAVA_PKG_COMPILER_DIR
100# @variable-internal JAVA_PKG_COMPILER_DIR 130# @INTERNAL
101# @default /usr/share/java-config-2/compiler 131# @DESCRIPTION:
102#
103# Directory where compiler settings are saved, without trailing slash. 132# Directory where compiler settings are saved, without trailing slash.
104# Probably shouldn't touch this variable. 133# You probably shouldn't touch this variable except local testing.
105# -----------------------------------------------------------------------------
106JAVA_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"}
107 135
108 136# @VARIABLE: JAVA_PKG_COMPILERS_CONF
109# ----------------------------------------------------------------------------- 137# @INTERNAL
110# @variable-internal JAVA_PKG_COMPILERS_CONF 138# @DESCRIPTION:
111# @variable-default /etc/java-config-2/build/compilers.conf
112#
113# Path to file containing information about which compiler to use. 139# Path to file containing information about which compiler to use.
114# Can be overloaded, but it should be overloaded for testing. 140# Can be overloaded, but it should be overloaded only for local testing.
115# -----------------------------------------------------------------------------
116JAVA_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"}
117 142
118# ----------------------------------------------------------------------------- 143# @ECLASS-VARIABLE: JAVA_PKG_FORCE_COMPILER
119# @variable-external JAVA_PKG_FORCE_COMPILER 144# @INTERNAL
120# 145# @DEFAULT_UNSET
146# @DESCRIPTION:
121# 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
122# JAVA_PKG_COMPILERS_CONF. 148# JAVA_PKG_COMPILERS_CONF.
123# 149#
124# @note This should only be used internally or for testing. 150# Useful for local testing.
151#
125# @example Use jikes and javac, in that order 152# Use jikes and javac, in that order
153# @CODE
126# JAVA_PKG_FORCE_COMPILER="jikes javac" 154# JAVA_PKG_FORCE_COMPILER="jikes javac"
127# ----------------------------------------------------------------------------- 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
128 169
129# TODO document me 170# TODO document me
130JAVA_PKG_QA_VIOLATIONS=0 171JAVA_PKG_QA_VIOLATIONS=0
131 172
132# ----------------------------------------------------------------------------- 173# @FUNCTION: java-pkg_doexamples
133# @section-end variables 174# @USAGE: [--subdir <subdir>] <file1/dir1> [<file2> ...]
134# ----------------------------------------------------------------------------- 175# @DESCRIPTION:
135 176# Installs given arguments to /usr/share/doc/${PF}/examples
136 177# If you give it only one parameter and it is a directory it will install
137# ----------------------------------------------------------------------------- 178# everything in that directory to the examples directory.
138# @section-begin install
139# @section-summary Install functions
140# 179#
141# These are used to install Java-related things, such as jars, Javadocs, JNI 180# @CODE
142# libraries, etc. 181# Parameters:
143# ----------------------------------------------------------------------------- 182# --subdir - If the examples need a certain directory structure
144 183# $* - list of files to install
145
146# -----------------------------------------------------------------------------
147# @ebuild-function java-pkg_dojar
148# 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:
149# Installs any number of jars. 223# Installs any number of jars.
150# 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.
151# You can use java-pkg_jarinto to change this path. 225# You can use java-pkg_jarinto to change this path.
152# 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.
153# Instead, use java-pkg_newjar defined below. 227# Instead, use java-pkg_newjar defined below.
154# 228#
155# @example 229# @CODE
156# java-pkg_dojar dist/${PN}.jar dist/${PN}-core.jar 230# java-pkg_dojar dist/${PN}.jar dist/${PN}-core.jar
231# @CODE
157# 232#
158# @param $* - list of jars to install 233# @param $* - list of jars to install
159# ------------------------------------------------------------------------------
160java-pkg_dojar() { 234java-pkg_dojar() {
161 debug-print-function ${FUNCNAME} $* 235 debug-print-function ${FUNCNAME} $*
162 236
163 [[ ${#} -lt 1 ]] && die "At least one argument needed" 237 [[ ${#} -lt 1 ]] && die "At least one argument needed"
164 238
168 # Create JARDEST if it doesn't exist 242 # Create JARDEST if it doesn't exist
169 dodir ${JAVA_PKG_JARDEST} 243 dodir ${JAVA_PKG_JARDEST}
170 244
171 local jar 245 local jar
172 # for each jar 246 # for each jar
173 for jar in "$@"; do 247 for jar in "${@}"; do
174 local jar_basename=$(basename "${jar}") 248 local jar_basename=$(basename "${jar}")
175 249
176 java-pkg_check-versioned-jar ${jar_basename} 250 java-pkg_check-versioned-jar ${jar_basename}
177 251
178 # check if it exists 252 # check if it exists
179 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
180 # install it into JARDEST if it's a non-symlink 261 # install it into JARDEST if it's a non-symlink
181 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
182 INSDESTTREE="${JAVA_PKG_JARDEST}" \ 266 INSDESTTREE="${JAVA_PKG_JARDEST}" \
183 doins "${jar}" || die "failed to install ${jar}" 267 doins "${jar}" || die "failed to install ${jar}"
184 java-pkg_append_ JAVA_PKG_CLASSPATH "${JAVA_PKG_JARDEST}/${jar_basename}" 268 java-pkg_append_ JAVA_PKG_CLASSPATH "${JAVA_PKG_JARDEST}/${jar_basename}"
185 debug-print "installed ${jar} to ${D}${JAVA_PKG_JARDEST}" 269 debug-print "installed ${jar} to ${D}${JAVA_PKG_JARDEST}"
186 # make a symlink to the original jar if it's symlink 270 # make a symlink to the original jar if it's symlink
196 done 280 done
197 281
198 java-pkg_do_write_ 282 java-pkg_do_write_
199} 283}
200 284
285# @FUNCTION: depend-java-query
286# @INTERNAL
287# @DESCRIPTION:
288# Wrapper for the depend-java-query binary to enable passing USE in env.
289# Using env variables keeps this eclass working with java-config versions that
290# do not handle use flags.
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.
294 USE="${USE}" /usr/bin/depend-java-query "${@}"
295}
201 296
202 297# @FUNCTION: java-pkg_regjar
203# ------------------------------------------------------------------------------ 298# @USAGE: </path/to/installed/jar>
204# @ebuild-function java-pkg_regjar 299# @DESCRIPTION:
205#
206# Records an already installed jar in the package.env 300# Records an already installed (in ${D}) jar in the package.env
207# 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
208# install things. 302# install things.
209# 303#
210# Example: 304# WARNING:
305# if you want to use shell expansion, you have to use ${D}/... as the for in
306# this function will not be able to expand the path, here's an example:
307#
308# @CODE
211# java-pkg-regjar ${D}/opt/foo/lib/foo.jar 309# java-pkg_regjar ${D}/opt/my-java/lib/*.jar
310# @CODE
212# 311#
213# @param $@ - jars to record 312
214# ------------------------------------------------------------------------------ 313# TODO should we be making sure the jar is present on ${D} or wherever?
215# TODO fix me!
216java-pkg_regjar() { 314java-pkg_regjar() {
217 debug-print-function ${FUNCNAME} $* 315 debug-print-function ${FUNCNAME} $*
218 316
219 java-pkg_check-phase install 317 java-pkg_check-phase install
220 318
221 [[ ${#} -lt 1 ]] && die "at least one argument needed" 319 [[ ${#} -lt 1 ]] && die "at least one argument needed"
222 320
223 java-pkg_init_paths_ 321 java-pkg_init_paths_
224 322
225 local jar jar_dir jar_file 323 local jar jar_dir jar_file
226 for jar in "$@"; do 324 for jar in "${@}"; do
227 # TODO use java-pkg_check-versioned-jar 325 # TODO use java-pkg_check-versioned-jar
228 if [[ -e "${jar}" ]]; then
229 java-pkg_append_ JAVA_PKG_CLASSPATH "${jar}"
230 elif [[ -e "${D}${jar}" ]]; then 326 if [[ -e "${jar}" || -e "${D}${jar}" ]]; then
327 [[ -d "${jar}" || -d "${D}${jar}" ]] \
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
333 # nelchael: we should strip ${D} in this case too, here's why:
334 # imagine such call:
335 # java-pkg_regjar ${D}/opt/java/*.jar
336 # such call will fall into this case (-e ${jar}) and will
337 # record paths with ${D} in package.env
231 java-pkg_append_ JAVA_PKG_CLASSPATH "${jar#${D}}" 338 java-pkg_append_ JAVA_PKG_CLASSPATH "${jar#${D}}"
232 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"
233 die "${jar} does not exist" 346 die "${jar} does not exist"
234 fi 347 fi
235 done 348 done
236 349
237 java-pkg_do_write_ 350 java-pkg_do_write_
238} 351}
239 352
240 353# @FUNCTION: java-pkg_newjar
241# ------------------------------------------------------------------------------ 354# @USAGE: <path/to/oldname.jar> [<newname.jar>]
242# @ebuild-function java-pkg_newjar 355# @DESCRIPTION:
356# Installs a jar with a new name (defaults to $PN.jar)
243# 357#
244# Installs a jar with a new name
245#
246# @example: install a versioned jar without the version 358# For example, installs a versioned jar without the version
247# java-pkg_newjar dist/${P}.jar ${PN}.jar
248#
249# @param $1 - jar to install
250# @param $2 - new name for jar - defaults to ${PN}.jar if not specified
251# ------------------------------------------------------------------------------
252java-pkg_newjar() { 359java-pkg_newjar() {
253 debug-print-function ${FUNCNAME} $* 360 debug-print-function ${FUNCNAME} $*
254 361
255 local original_jar="${1}" 362 local original_jar="${1}"
256 local new_jar="${2:-${PN}.jar}" 363 local new_jar="${2:-${PN}.jar}"
257 local new_jar_dest="${T}/${new_jar}" 364 local new_jar_dest="${T}/${new_jar}"
258 365
259 [[ -z ${original_jar} ]] && die "Must specify a jar to install" 366 [[ -z ${original_jar} ]] && die "Must specify a jar to install"
260 [[ ! -f ${original_jar} ]] && die "${new_jar} does not exist!" 367 [[ ! -f ${original_jar} ]] \
368 && die "${original_jar} does not exist or is not a file!"
261 369
262 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}"
263 cp "${original_jar}" "${new_jar_dest}" \ 371 cp "${original_jar}" "${new_jar_dest}" \
264 || die "Failed to copy ${original_jar} to ${new_jar_dest}" 372 || die "Failed to copy ${original_jar} to ${new_jar_dest}"
265 java-pkg_dojar "${new_jar_dest}" 373 java-pkg_dojar "${new_jar_dest}"
266} 374}
267 375
268 376# @FUNCTION: java-pkg_addcp
269# ------------------------------------------------------------------------------ 377# @USAGE: <classpath>
270# @ebuild-function java-pkg_addcp 378# @DESCRIPTION:
271#
272# 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,
273# 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.
274# 381# The parameters of this function are appended to JAVA_PKG_CLASSPATH
275# TODO add example
276# @param $@ - value to append to JAVA_PKG_CLASSPATH
277# ------------------------------------------------------------------------------
278java-pkg_addcp() { 382java-pkg_addcp() {
279 java-pkg_append_ JAVA_PKG_CLASSPATH "${@}" 383 java-pkg_append_ JAVA_PKG_CLASSPATH "${@}"
280 java-pkg_do_write_ 384 java-pkg_do_write_
281} 385}
282 386
283 387# @FUNCTION: java-pkg_doso
284# ------------------------------------------------------------------------------ 388# @USAGE: <path/to/file1.so> [...]
285# @ebuild-function java-pkg_doso 389# @DESCRIPTION:
286#
287# Installs any number of JNI libraries 390# Installs any number of JNI libraries
288# 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
289# can be used change this path 392# can be used change this path
290# 393#
394# @CODE
291# Example: 395# Example:
292# java-pkg_doso *.so 396# java-pkg_doso *.so
293# 397# @CODE
294# @param $@ - JNI libraries to install
295# ------------------------------------------------------------------------------
296java-pkg_doso() { 398java-pkg_doso() {
297 debug-print-function ${FUNCNAME} $* 399 debug-print-function ${FUNCNAME} $*
298 400
299 [[ ${#} -lt 1 ]] && "At least one argument required for ${FUNCNAME}"
300 java-pkg_check-phase install 401 java-pkg_check-phase install
301 402
302 [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}" 403 [[ ${#} -lt 1 ]] && die "${FUNCNAME} requires at least one argument"
303 404
304 java-pkg_init_paths_ 405 java-pkg_init_paths_
305 406
306 local lib 407 local lib
307 # for each lib 408 # for each lib
310 if [[ -e "${lib}" ]] ; then 411 if [[ -e "${lib}" ]] ; then
311 # install if it isn't a symlink 412 # install if it isn't a symlink
312 if [[ ! -L "${lib}" ]] ; then 413 if [[ ! -L "${lib}" ]] ; then
313 INSDESTTREE="${JAVA_PKG_LIBDEST}" \ 414 INSDESTTREE="${JAVA_PKG_LIBDEST}" \
314 INSOPTIONS="${LIBOPTIONS}" \ 415 INSOPTIONS="${LIBOPTIONS}" \
315 doins "${lib}" || "failed to install ${lib}" 416 doins "${lib}" || die "failed to install ${lib}"
316 java-pkg_append_ JAVA_PKG_LIBRARY "${JAVA_PKG_LIBDEST}" 417 java-pkg_append_ JAVA_PKG_LIBRARY "${JAVA_PKG_LIBDEST}"
317 debug-print "Installing ${lib} to ${JAVA_PKG_LIBDEST}" 418 debug-print "Installing ${lib} to ${JAVA_PKG_LIBDEST}"
318 # otherwise make a symlink to the symlink's origin 419 # otherwise make a symlink to the symlink's origin
319 else 420 else
320 # TODO use dosym
321 ln -s "$(readlink "${lib}")" "${D}${JAVA_PKG_LIBDEST}/$(basename "${lib}")" 421 dosym "$(readlink "${lib}")" "${JAVA_PKG_LIBDEST}/${lib##*/}"
322 debug-print "${lib} is a symlink, linking accordanly" 422 debug-print "${lib} is a symlink, linking accordantly"
323 fi 423 fi
324 # otherwise die 424 # otherwise die
325 else 425 else
326 die "${lib} does not exist" 426 die "${lib} does not exist"
327 fi 427 fi
328 done 428 done
329 429
330 java-pkg_do_write_ 430 java-pkg_do_write_
331} 431}
332 432
333# ------------------------------------------------------------------------------ 433# @FUNCTION: java-pkg_regso
334# @ebuild-function java-pkg_regso 434# @USAGE: <file1.so> [...]
335# 435# @DESCRIPTION:
336# 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
337# 441#
338# Example: 442# Example:
339# java-pkg_regso *.so /path/*.so 443# java-pkg_regso *.so /path/*.so
340# 444# @CODE
341# @param $@ - JNI libraries to register
342# ------------------------------------------------------------------------------
343java-pkg_regso() { 445java-pkg_regso() {
344 debug-print-function ${FUNCNAME} $* 446 debug-print-function ${FUNCNAME} $*
345 447
346 java-pkg_check-phase install 448 java-pkg_check-phase install
347 449
348 [[ ${#} -lt 1 ]] && "at least one argument needed" 450 [[ ${#} -lt 1 ]] && die "${FUNCNAME} requires at least one argument"
349 451
350 java-pkg_init_paths_ 452 java-pkg_init_paths_
351 453
352 local lib target_dir 454 local lib target_dir
353 for lib in "$@" ; do 455 for lib in "$@" ; do
354 # Check the absolute path of the lib 456 # Check the absolute path of the lib
355 if [[ -e "${lib}" ]] ; then 457 if [[ -e "${lib}" ]] ; then
356 target_dir="$(java-pkg_expand_dir_ ${lib})" 458 target_dir="$(java-pkg_expand_dir_ ${lib})"
365 done 467 done
366 468
367 java-pkg_do_write_ 469 java-pkg_do_write_
368} 470}
369 471
370# ------------------------------------------------------------------------------ 472# @FUNCTION: java-pkg_jarinto
371# @ebuild-function java-pkg_jarinto 473# @USAGE: </path/to/install/jars/into>
372# 474# @DESCRIPTION:
373# Changes the path jars are installed into 475# Changes the path jars are installed into via subsequent java-pkg_dojar calls.
374#
375# @param $1 - new location to install jars into.
376# -----------------------------------------------------------------------------
377java-pkg_jarinto() { 476java-pkg_jarinto() {
378 debug-print-function ${FUNCNAME} $* 477 debug-print-function ${FUNCNAME} $*
379 478
380 JAVA_PKG_JARDEST="${1}" 479 JAVA_PKG_JARDEST="${1}"
381} 480}
382 481
383# ------------------------------------------------------------------------------ 482# @FUNCTION: java-pkg_sointo
384# @ebuild-function java-pkg_sointo 483# @USAGE: </path/to/install/sofiles/into>
385# 484# @DESCRIPTION:
386# Changes the path that JNI libraries are installed into. 485# Changes the path that JNI libraries are installed into via subsequent
387# 486# java-pkg_doso calls.
388# @param $1 - new location to install JNI libraries into.
389# ------------------------------------------------------------------------------
390java-pkg_sointo() { 487java-pkg_sointo() {
391 debug-print-function ${FUNCNAME} $* 488 debug-print-function ${FUNCNAME} $*
392 489
393 JAVA_PKG_LIBDEST="${1}" 490 JAVA_PKG_LIBDEST="${1}"
394} 491}
395 492
396# ------------------------------------------------------------------------------ 493# @FUNCTION: java-pkg_dohtml
397# @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.
398# 497#
399# Install Javadoc HTML documentation 498# @CODE
400#
401# @example
402# java-pkg_dohtml dist/docs/ 499# java-pkg_dohtml dist/docs/
403# 500# @CODE
404# ------------------------------------------------------------------------------
405java-pkg_dohtml() { 501java-pkg_dohtml() {
406 debug-print-function ${FUNCNAME} $* 502 debug-print-function ${FUNCNAME} $*
407 503
408 [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}" 504 [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}"
409 # TODO-nichoj find out what exactly -f package-list does 505
506 # from /usr/lib/portage/bin/dohtml -h
507 # -f Set list of allowed extensionless file names.
410 dohtml -f package-list "$@" 508 dohtml -f package-list "$@"
509
411 # this probably shouldn't be here but it provides 510 # this probably shouldn't be here but it provides
412 # a reasonable way to catch # docs for all of the 511 # a reasonable way to catch # docs for all of the
413 # old ebuilds. 512 # old ebuilds.
414 java-pkg_recordjavadoc 513 java-pkg_recordjavadoc
415} 514}
416 515
417# TODO document 516# @FUNCTION: java-pkg_dojavadoc
517# @USAGE: [--symlink destination] <path/to/javadocs/root>
518# @DESCRIPTION:
519# Installs javadoc documentation. This should be controlled by the doc use flag.
520#
521# @CODE
522# Parameters:
523# $1: optional --symlink creates to symlink like this for html
524# documentation bundles.
525# $2: - The javadoc root directory.
526#
527# Examples:
528# java-pkg_dojavadoc docs/api
529# java-pkg_dojavadoc --symlink apidocs docs/api
530# @CODE
418java-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
419 local dir="$1" 541 local dir="$1"
542 local dest=/usr/share/doc/${PF}/html
543
544 # QA checks
420 545
421 java-pkg_check-phase install 546 java-pkg_check-phase install
547 java-pkg_init_paths_
422 548
423 [[ -z "${dir}" ]] && die "Must specify a directory!" 549 [[ -z "${dir}" ]] && die "Must specify a directory!"
424 [[ ! -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
425 563
426 local dir_to_install="${dir}" 564 local dir_to_install="${dir}"
427 if [[ "$(basename "${dir}")" != "api" ]]; then 565 if [[ "$(basename "${dir}")" != "api" ]]; then
428 dir_to_install="${T}/api" 566 dir_to_install="${T}/api"
429 # TODO use doins 567 # TODO use doins
430 cp -r "${dir}" "${dir_to_install}" || die "cp failed" 568 cp -r "${dir}" "${dir_to_install}" || die "cp failed"
431 fi 569 fi
432 570
571 # Actual installation
572
433 java-pkg_dohtml -r ${dir_to_install} 573 java-pkg_dohtml -r "${dir_to_install}"
434}
435 574
436# ------------------------------------------------------------------------------ 575 # Let's make a symlink to the directory we have everything else under
437# @ebuild-function java-pkg_dosrc 576 dosym ${dest}/api "${JAVA_PKG_SHAREPATH}/api" || die
438# 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:
439# 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
440# 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.
441# 590#
442# Ebuild needs to DEPEND on app-arch/zip to use this. 591# @CODE
443#
444# It also should be controlled by USE=source.
445#
446# @example: 592# Example:
447# java-pkg_dosrc src/* 593# java-pkg_dosrc src/*
448# 594# @CODE
449# ------------------------------------------------------------------------------ 595
450# 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
451# source -nichoj 597# source -nichoj
598#
452# 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#
453# TODO maybe we can take an existing zip/jar? -nichoj 601# TODO maybe we can take an existing zip/jar? -nichoj
602#
454# FIXME apparently this fails if you give it an empty directories 603# FIXME apparently this fails if you give it an empty directories
455java-pkg_dosrc() { 604java-pkg_dosrc() {
456 debug-print-function ${FUNCNAME} $* 605 debug-print-function ${FUNCNAME} $*
457 606
458 [ ${#} -lt 1 ] && die "At least one argument needed" 607 [ ${#} -lt 1 ] && die "At least one argument needed"
459 if ! hasq source ${IUSE}; then
460 echo "Java QA Notice: ${FUNCNAME} called without source in IUSE"
461 fi
462 608
463 java-pkg_check-phase install 609 java-pkg_check-phase install
464 610
465 [[ ${#} -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
466 617
467 java-pkg_init_paths_ 618 java-pkg_init_paths_
468 619
469 local zip_name="${PN}-src.zip" 620 local zip_name="${PN}-src.zip"
470 local zip_path="${T}/${zip_name}" 621 local zip_path="${T}/${zip_name}"
471 local dir 622 local dir
472 for dir in ${@}; do 623 for dir in "${@}"; do
473 local dir_parent=$(dirname "${dir}") 624 local dir_parent=$(dirname "${dir}")
474 local dir_name=$(basename "${dir}") 625 local dir_name=$(basename "${dir}")
475 pushd ${dir_parent} > /dev/null || die "problem entering ${dir_parent}" 626 pushd ${dir_parent} > /dev/null || die "problem entering ${dir_parent}"
476 zip -q -r ${zip_path} ${dir_name} -i '*.java' 627 zip -q -r ${zip_path} ${dir_name} -i '*.java'
477 local result=$? 628 local result=$?
488 639
489 JAVA_SOURCES="${JAVA_PKG_SOURCESPATH}/${zip_name}" 640 JAVA_SOURCES="${JAVA_PKG_SOURCESPATH}/${zip_name}"
490 java-pkg_do_write_ 641 java-pkg_do_write_
491} 642}
492 643
493# ------------------------------------------------------------------------------ 644# @FUNCTION: java-pkg_dolauncher
494# @ebuild-function java-pkg_dolauncher 645# @USAGE: <filename> [options]
495# 646# @DESCRIPTION:
496# Make a wrapper script to lauch/start this package 647# Make a wrapper script to lauch/start this package
497# If necessary, the wrapper will switch to the appropriate VM. 648# If necessary, the wrapper will switch to the appropriate VM.
498# 649#
650# Can be called without parameters if the package installs only one jar
651# that has the Main-class attribute set. The wrapper will be named ${PN}.
652#
653# @CODE
654# Parameters:
499# @param $1 - filename of launcher to create 655# $1 - filename of launcher to create
500# @param $2 - options, as follows: 656# $2 - options, as follows:
501# --main the.main.class.too.start 657# --main the.main.class.to.start
502# --jar /the/jar/too/launch.jar 658# --jar /the/jar/too/launch.jar or just <name>.jar
503# --java_args 'Extra arguments to pass too jave' 659# --java_args 'Extra arguments to pass to java'
504# --pkg_args 'extra arguments too pass too the package' 660# --pkg_args 'Extra arguments to pass to the package'
505# --pwd 661# --pwd Directory the launcher changes to before executing java
506# -into 662# -into Directory to install the launcher to, instead of /usr/bin
507# -pre 663# -pre Prepend contents of this file to the launcher
508# ------------------------------------------------------------------------------ 664# @CODE
509java-pkg_dolauncher() { 665java-pkg_dolauncher() {
510 debug-print-function ${FUNCNAME} $* 666 debug-print-function ${FUNCNAME} $*
511 667
512 java-pkg_check-phase install 668 java-pkg_check-phase install
513
514 [[ ${#} -lt 1 ]] && die "Need at least one argument"
515
516 java-pkg_init_paths_ 669 java-pkg_init_paths_
517 670
671 if [[ ${#} = 0 ]]; then
672 local name="${PN}"
673 else
518 local name="${1}" 674 local name="${1}"
675 shift
676 fi
677
519 # TODO rename to launcher 678 # TODO rename to launcher
520 local target="${T}/${name}" 679 local target="${T}/${name}"
680 local var_tmp="${T}/launcher_variables_tmp"
521 local target_dir pre 681 local target_dir pre
522 shift
523 682
524 echo "#!/bin/bash" > "${target}" 683 # Process the other the rest of the arguments
525 while [[ -n "${1}" && -n "${2}" ]]; do 684 while [[ -n "${1}" && -n "${2}" ]]; do
526 local var=${1} value=${2} 685 local var="${1}" value="${2}"
527 if [[ "${var:0:2}" == "--" ]]; then 686 if [[ "${var:0:2}" == "--" ]]; then
687 local var=${var:2}
528 echo "gjl_${var:2}=\"${value}\"" >> "${target}" 688 echo "gjl_${var}=\"${value}\"" >> "${var_tmp}"
689 local gjl_${var}="${value}"
529 elif [[ "${var}" == "-into" ]]; then 690 elif [[ "${var}" == "-into" ]]; then
530 target_dir="${value}" 691 target_dir="${value}"
531 elif [[ "${var}" == "-pre" ]]; then 692 elif [[ "${var}" == "-pre" ]]; then
532 pre="${value}" 693 pre="${value}"
533 fi 694 fi
534 shift 2 695 shift 2
535 done 696 done
697
698 # Test if no --jar and --main arguments were given and
699 # in that case check if the package only installs one jar
700 # and use that jar.
701 if [[ -z "${gjl_jar}" && -z "${gjl_main}" ]]; then
702 local cp="${JAVA_PKG_CLASSPATH}"
703 if [[ "${cp/:}" = "${cp}" && "${cp%.jar}" != "${cp}" ]]; then
704 echo "gjl_jar=\"${JAVA_PKG_CLASSPATH}\"" >> "${var_tmp}"
705 else
706 local msg="Not enough information to create a launcher given."
707 msg="${msg} Please give --jar or --main argument to ${FUNCNAME}."
708 die "${msg}"
709 fi
710 fi
711
712 # Write the actual script
713 echo "#!/bin/bash" > "${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
536 echo "gjl_package=${JAVA_PKG_NAME}" >> "${target}" 721 echo "gjl_package=${JAVA_PKG_NAME}" >> "${target}"
537 [[ -n "${pre}" ]] && [[ -f "${pre}" ]] && cat "${pre}" >> "${target}" 722 cat "${var_tmp}" >> "${target}"
723 rm -f "${var_tmp}"
538 echo "source /usr/share/java-config-2/launcher/launcher.bash" >> "${target}" 724 echo "source /usr/share/java-config-2/launcher/launcher.bash" >> "${target}"
539 725
540 if [[ -n "${into}" ]]; then 726 if [[ -n "${target_dir}" ]]; then
541 DESTTREE="${target_dir}" dobin "${target}" 727 DESTTREE="${target_dir}" dobin "${target}"
542 local ret=$? 728 local ret=$?
543 return ${ret} 729 return ${ret}
544 else 730 else
545 dobin "${target}" 731 dobin "${target}"
546 fi 732 fi
547} 733}
548 734
549# ------------------------------------------------------------------------------ 735# @FUNCTION: java-pkg_dowar
736# @DESCRIPTION:
550# Install war files. 737# Install war files.
551# TODO document 738# TODO document
552# ------------------------------------------------------------------------------
553java-pkg_dowar() { 739java-pkg_dowar() {
554 debug-print-function ${FUNCNAME} $* 740 debug-print-function ${FUNCNAME} $*
555 741
556 # Check for arguments 742 # Check for arguments
557 [[ ${#} -lt 1 ]] && die "At least one argument needed" 743 [[ ${#} -lt 1 ]] && die "At least one argument needed"
573 echo "dowar: warning, skipping directory ${war}" 759 echo "dowar: warning, skipping directory ${war}"
574 continue 760 continue
575 else 761 else
576 warpath="${war}" 762 warpath="${war}"
577 fi 763 fi
578 764
579 # Install those files like you mean it 765 # Install those files like you mean it
580 INSOPTIONS="-m 0644" \ 766 INSOPTIONS="-m 0644" \
581 INSDESTTREE=${JAVA_PKG_WARDEST} \ 767 INSDESTTREE=${JAVA_PKG_WARDEST} \
582 doins ${warpath} 768 doins ${warpath}
583 done 769 done
584} 770}
585 771
586# ------------------------------------------------------------------------------ 772# @FUNCTION: java-pkg_recordjavadoc
587# @internal-function java-pkg_recordjavadoc 773# @INTERNAL
774# @DESCRIPTION:
588# 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
589# 776
590# TODO make sure this in the proper section 777# TODO make sure this in the proper section
591# ------------------------------------------------------------------------------
592java-pkg_recordjavadoc() 778java-pkg_recordjavadoc()
593{ 779{
594 debug-print-function ${FUNCNAME} $* 780 debug-print-function ${FUNCNAME} $*
595 # the find statement is important 781 # the find statement is important
596 # as some packages include multiple trees of javadoc 782 # as some packages include multiple trees of javadoc
603 else 789 else
604 debug-print "No javadocs found" 790 debug-print "No javadocs found"
605 fi 791 fi
606} 792}
607 793
608# ------------------------------------------------------------------------------
609# @section-end install
610# ------------------------------------------------------------------------------
611 794
612# ------------------------------------------------------------------------------ 795# @FUNCTION: java-pkg_jar-from
613# @begin-section query 796# @USAGE: [--build-only] [--with-dependencies] [--virtual] [--into dir] <package> [<package.jar>] [<destination.jar>]
614# Use these to build the classpath for building a package. 797# @DESCRIPTION:
615# ------------------------------------------------------------------------------
616
617# ------------------------------------------------------------------------------
618# @ebuild-function java-pkg_jar-from
619#
620# Makes a symlink to a jar from a certain package 798# Makes a symlink to a jar from a certain package
621# A lot of java packages include dependencies in a lib/ directory 799# A lot of java packages include dependencies in a lib/ directory
622# You can use this function to replace these bundled dependencies. 800# You can use this function to replace these bundled dependencies.
801# The dependency is recorded into package.env DEPEND line, unless "--build-only"
802# is passed as the very first argument, for jars that have to be present only
803# at build time and are not needed on runtime (junit testing etc).
623# 804#
805# @CODE
624# Example: get all jars from xerces slot 2 806# Example: get all jars from xerces slot 2
625# java-pkg_jar-from xerces-2 807# java-pkg_jar-from xerces-2
808#
626# Example: get a specific jar from xerces slot 2 809# Example: get a specific jar from xerces slot 2
627# java-pkg_jar-from xerces-2 xml-apis.jar 810# java-pkg_jar-from xerces-2 xml-apis.jar
811#
628# 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
629# java-pkg_jar-from xerces-2 xml-apis.jar xml.jar 813# java-pkg_jar-from xerces-2 xml-apis.jar xml.jar
630# 814#
631# @param $1 - Package to get jars from. 815# Example: get junit.jar which is needed only for building
816# java-pkg_jar-from --build-only junit junit.jar
817# @CODE
818#
819# @CODE
820# Parameters
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.
632# @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.
633# @param $3 - When a single jar is specified, destination filename of the 831# $3 - When a single jar is specified, destination filename of the
634# symlink. Defaults to the name of the jar. 832# symlink. Defaults to the name of the jar.
635# ------------------------------------------------------------------------------ 833# @CODE
834
636# TODO could probably be cleaned up a little 835# TODO could probably be cleaned up a little
637java-pkg_jar-from() { 836java-pkg_jar-from() {
638 debug-print-function ${FUNCNAME} $* 837 debug-print-function ${FUNCNAME} $*
639 838
839 local build_only=""
840 local destdir="."
841 local deep=""
842 local virtual=""
843 local record_jar=""
844
845 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
846
847 while [[ "${1}" == --* ]]; do
848 if [[ "${1}" = "--build-only" ]]; then
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
860 shift
861 done
862
640 local target_pkg="${1}" target_jar="${2}" destjar="${3}" 863 local target_pkg="${1}" target_jar="${2}" destjar="${3}"
641 864
642 [[ -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
643 870
644 # default destjar to the target jar 871 # default destjar to the target jar
645 [[ -z "${destjar}" ]] && destjar="${target_jar}" 872 [[ -z "${destjar}" ]] && destjar="${target_jar}"
646 873
874 local error_msg="There was a problem getting the classpath for ${target_pkg}."
875 local classpath
647 local classpath="$(java-config --classpath=${target_pkg})" 876 classpath="$(java-config ${deep} --classpath=${target_pkg})"
648 [[ $? != 0 ]] && die "There was a problem getting the classpath for ${target_pkg}" 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}"
649 903
650 local jar 904 local jar
651 for jar in ${classpath//:/ }; do 905 for jar in ${classpath//:/ }; do
652 local jar_name=$(basename "${jar}") 906 local jar_name=$(basename "${jar}")
653 if [[ ! -f "${jar}" ]] ; then 907 if [[ ! -f "${jar}" ]] ; then
657 # If no specific target jar was indicated, link it 911 # If no specific target jar was indicated, link it
658 if [[ -z "${target_jar}" ]] ; then 912 if [[ -z "${target_jar}" ]] ; then
659 [[ -f "${target_jar}" ]] && rm "${target_jar}" 913 [[ -f "${target_jar}" ]] && rm "${target_jar}"
660 ln -snf "${jar}" \ 914 ln -snf "${jar}" \
661 || 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
662 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
663 # otherwise, if the current jar is the target jar, link it 923 # otherwise, if the current jar is the target jar, link it
664 elif [[ "${jar_name}" == "${target_jar}" ]] ; then 924 elif [[ "${jar_name}" == "${target_jar}" ]] ; then
665 [[ -f "${destjar}" ]] && rm "${destjar}" 925 [[ -f "${destjar}" ]] && rm "${destjar}"
666 ln -snf "${jar}" "${destjar}" \ 926 ln -snf "${jar}" "${destjar}" \
667 || 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
668 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
669 return 0 936 return 0
670 fi 937 fi
671 done 938 done
939 popd > /dev/null
672 # if no target was specified, we're ok 940 # if no target was specified, we're ok
673 if [[ -z "${target_jar}" ]] ; then 941 if [[ -z "${target_jar}" ]] ; then
674 return 0 942 return 0
675 # otherwise, die bitterly 943 # otherwise, die bitterly
676 else 944 else
677 die "Failed to find ${target_jar:-jar} in ${target_pkg}" 945 die "Failed to find ${target_jar:-jar} in ${target_pkg}"
678 fi 946 fi
679} 947}
680 948
681# ------------------------------------------------------------------------------ 949# @FUNCTION: java-pkg_jarfrom
682# @ebuild-function java-pkg_jarfrom 950# @DESCRIPTION:
683#
684# See java-pkg_jar-from 951# See java-pkg_jar-from
685# ------------------------------------------------------------------------------
686java-pkg_jarfrom() { 952java-pkg_jarfrom() {
687 java-pkg_jar-from "$@" 953 java-pkg_jar-from "$@"
688} 954}
689 955
690# ------------------------------------------------------------------------------ 956# @FUNCTION: java-pkg_getjars
691# @ebuild-function java-pkg_getjars 957# @USAGE: [--build-only] [--with-dependencies] <package1>[,<package2>...]
692# 958# @DESCRIPTION:
693# Get the classpath provided by any number of packages 959# Get the classpath provided by any number of packages
694# 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'.
961# The providing packages are recorded as dependencies into package.env DEPEND
962# line, unless "--build-only" is passed as the very first argument, for jars
963# that have to be present only at build time and are not needed on runtime
964# (junit testing etc).
695# 965#
966# @CODE
696# Example: Get the classpath for xerces-2, 967# Example: Get the classpath for xerces-2 and xalan,
697# java-pkg_getjars xerces-2 xalan 968# java-pkg_getjars xerces-2,xalan
969#
698# Example Return: 970# Example Return:
699# /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
700# 972#
973#
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.
701# @param $@ - list of packages to get jars from 979# $1 - list of packages to get jars from
702# ------------------------------------------------------------------------------ 980# (passed to java-config --classpath)
981# @CODE
703java-pkg_getjars() { 982java-pkg_getjars() {
704 debug-print-function ${FUNCNAME} $* 983 debug-print-function ${FUNCNAME} $*
705 984
706 [[ ${#} -lt 1 ]] && die "At least one argument needed" 985 local build_only=""
986 local deep=""
707 987
708 # NOTE could probably just pass $@ to java-config --classpath. and return it 988 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
709 local classpath pkg 989
710 for pkg in ${@//,/ }; do 990 while [[ "${1}" == --* ]]; do
711 #for pkg in $(echo "$@" | tr ',' ' '); do 991 if [[ "${1}" = "--build-only" ]]; then
712 jars="$(java-config --classpath=${pkg})" 992 build_only="build"
713 debug-print "${pkg}:${jars}" 993 elif [[ "${1}" = "--with-dependencies" ]]; then
714 # TODO should we ensure jars exist? 994 deep="--with-dependencies"
715 if [[ -z "${classpath}" ]]; then
716 classpath="${jars}"
717 else 995 else
718 classpath="${classpath}:${jars}" 996 die "java-pkg_jar-from called with unknown parameter: ${1}"
719 fi 997 fi
720 java-pkg_record-jar_ "${pkg}" 998 shift
721 done 999 done
722 echo "${classpath}"
723}
724 1000
725# ------------------------------------------------------------------------------ 1001 [[ ${#} -ne 1 ]] && die "${FUNCNAME} takes only one argument besides --*"
726# @ebuild-function java-pkg_getjar 1002
727# 1003
1004 local pkgs="${1}"
1005
1006 if [[ "${EAPI}" == "1" ]]; then
1007 pkgs="${pkgs//:/-}"
1008 fi
1009
1010 jars="$(java-config ${deep} --classpath=${pkgs})"
1011 [[ $? != 0 ]] && die "java-config --classpath=${pkgs} failed"
1012 debug-print "${pkgs}:${jars}"
1013
1014 for pkg in ${pkgs//,/ }; do
1015 java-pkg_ensure-dep "${build_only}" "${pkg}"
1016 done
1017
1018 for pkg in ${pkgs//,/ }; do
1019 if [[ -z "${build_only}" ]]; then
1020 java-pkg_record-jar_ "${pkg}"
1021 else
1022 java-pkg_record-jar_ --build-only "${pkg}"
1023 fi
1024 done
1025
1026 echo "${jars}"
1027}
1028
1029# @FUNCTION: java-pkg_getjar
1030# @USAGE: [--build-only] [--virtual] <package> <jarfile>
1031# @DESCRIPTION:
728# Get the filename of a single jar from a package 1032# Get the complete path of a single jar from a package
1033# The providing package is recorded as runtime dependency into package.env
1034# DEPEND line, unless "--build-only" is passed as the very first argument, for
1035# jars that have to be present only at build time and are not needed on runtime
1036# (junit testing etc).
729# 1037#
1038# @CODE
730# @example 1039# Example:
731# java-pkg_getjar xerces-2 xml-apis.jar 1040# java-pkg_getjar xerces-2 xml-apis.jar
732# @example-return 1041# returns
733# /usr/share/xerces-2/lib/xml-apis.jar 1042# /usr/share/xerces-2/lib/xml-apis.jar
734# 1043#
1044# Parameters:
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.
735# @param $1 - package to use 1048# $1 - package to use
736# @param $2 - jar to get 1049# $2 - jar to get
737# ------------------------------------------------------------------------------ 1050# @CODE
738java-pkg_getjar() { 1051java-pkg_getjar() {
739 debug-print-function ${FUNCNAME} $* 1052 debug-print-function ${FUNCNAME} $*
740 1053
1054 local build_only=""
1055 local virtual=""
1056 local record_jar=""
1057
1058 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
1059
1060 while [[ "${1}" == --* ]]; do
1061 if [[ "${1}" = "--build-only" ]]; then
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
1068 shift
1069 done
1070
1071 [[ ${#} -ne 2 ]] && die "${FUNCNAME} takes only two arguments besides --*"
1072
741 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
742 [[ -z ${pkg} ]] && die "Must specify package to get a jar from" 1079 [[ -z ${pkg} ]] && die "Must specify package to get a jar from"
743 [[ -z ${target_jar} ]] && die "Must specify jar to get" 1080 [[ -z ${target_jar} ]] && die "Must specify jar to get"
744 1081
745 # TODO check that package is actually installed 1082 local error_msg="Could not find classpath for ${pkg}. Are you sure its installed?"
1083 local classpath
746 local classpath=$(java-config --classpath=${pkg}) 1084 classpath=$(java-config --classpath=${pkg})
747 [[ $? != 0 ]] && die "There could not find classpath for ${pkg}. Are you sure its installed?" 1085 [[ $? != 0 ]] && die ${error_msg}
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
748 for jar in ${classpath//:/ }; do 1100 for jar in ${classpath//:/ }; do
749 if [[ ! -f "${jar}" ]] ; then 1101 if [[ ! -f "${jar}" ]] ; then
750 die "Installation problems with jars in ${pkg} - is it installed?" 1102 die "Installation problem with jar ${jar} in ${pkg} - is it installed?"
751 fi 1103 fi
752 1104
753 if [[ "$(basename ${jar})" == "${target_jar}" ]] ; then 1105 if [[ "$(basename ${jar})" == "${target_jar}" ]] ; then
1106 # Only record jars that aren't build-only
1107 if [[ -z "${record_jar}" ]]; then
1108 if [[ -z "${build_only}" ]]; then
754 java-pkg_record-jar_ "${pkg}" "${jar}" 1109 java-pkg_record-jar_ "${pkg}" "${jar}"
1110 else
1111 java-pkg_record-jar_ --build-only "${pkg}" "${jar}"
1112 fi
1113 fi
755 echo "${jar}" 1114 echo "${jar}"
756 return 0 1115 return 0
757 fi 1116 fi
758 done 1117 done
759 1118
760 die "Could not find ${target_jar} in ${pkg}" 1119 die "Could not find ${target_jar} in ${pkg}"
761 return 1 1120 return 1
762} 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
763 1287
764# 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
765# populate jars from the filesystem. 1289# populate jars from the filesystem.
766# 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
767# string that was built instead of stdin 1291# string that was built instead of stdin
778# line="${line// /}" 1302# line="${line// /}"
779# 1303#
780# # format: path=jarinfo 1304# # format: path=jarinfo
781# local path=${line%%=*} 1305# local path=${line%%=*}
782# local jarinfo=${line##*=} 1306# local jarinfo=${line##*=}
783# 1307#
784# # format: jar@package 1308# # format: jar@package
785# local jar=${jarinfo%%@*}.jar 1309# local jar=${jarinfo%%@*}.jar
786# local package=${jarinfo##*@} 1310# local package=${jarinfo##*@}
787# if [[ -n ${replace_only} ]]; then 1311# if [[ -n ${replace_only} ]]; then
788# [[ ! -f $path ]] && die "No jar exists at ${path}" 1312# [[ ! -f $path ]] && die "No jar exists at ${path}"
795# 1319#
796# read line 1320# read line
797# done 1321# done
798#} 1322#}
799 1323
800# ------------------------------------------------------------------------------ 1324# @FUNCTION: java-pkg_find-normal-jars
801# @section-end query 1325# @USAGE: [<path/to/directory>]
802# ------------------------------------------------------------------------------ 1326# @DESCRIPTION:
803 1327# Find the files with suffix .jar file in the given directory (default: $WORKDIR)
804# ------------------------------------------------------------------------------ 1328java-pkg_find-normal-jars() {
805# @section-begin helper 1329 local dir=$1
806# @section-summary Helper functions 1330 [[ "${dir}" ]] || dir="${WORKDIR}"
807# 1331 local found
808# Various other functions to use from an ebuild 1332 for jar in $(find "${dir}" -name "*.jar" -type f); do
809# ------------------------------------------------------------------------------ 1333 echo "${jar}"
810 1334 found="true"
811# ------------------------------------------------------------------------------
812# @ebuild-function java-pkg_need
813#
814# Adds virtual dependencies, which can optionally be controlled by a USE flag.
815# Currently supported virtuals are:
816# javamail
817# jdbc-stdext
818# jaf
819# jdbc-rowset
820# jms
821#
822# @param $1 - Optionally indicate that the dependencies are controlled by
823# a use flag by specifying '--use' Requires $2.
824# @param $2 - USE flag which will enable the dependencies.
825# @param $@ - virtual packages to add depenedencies for
826# ------------------------------------------------------------------------------
827# TODO rewrite to parse a line based declaration file instead -- karltk
828#java-pkg_need() {
829# debug-print-function ${FUNCNAME} $*
830# local useflag
831# if [[ ${1} == "--use" ]]; then
832# useflag="${2}"
833# shift 2
834# fi
835#
836# if [[ -z ${1} ]]; then
837# die "Must specify at least one virtual package."
838# fi
839#
840# local depstr newdepstr
841#
842# for virtual in ${@}; do
843# if has ${virtual} ${JAVA_PKG_VNEED}; then
844# debug-print "Already registered virtual ${virtual}"
845# continue
846# fi
847# case ${virtual} in
848# javamail)
849# debug-print "java-pkg_need: adding javamail dependencies"
850# newdepstr="|| ( dev-java/gnu-javamail dev-java/sun-javamail-bin )"
851# ;;
852# jdbc-stdext)
853# debug-print "java-pkg_need: adding jdbc-stdext dependencies"
854# newdepstr="|| ( >=virtual/jdk-1.4 dev-java/jdbc2-stdext )"
855# ;;
856# jaf)
857# debug-print "java-pkg_need: adding jaf dependencies"
858# newdepstr="|| ( dev-java/gnu-jaf dev-java/sun-jaf-bin )"
859# ;;
860# jdbc-rowset)
861# debug-print "java-pkg_need: adding jdbc-rowset dependencies"
862# newdepstr="|| ( >=virtual/jdk-1.5 dev-java/sun-jdbc-rowset )"
863# ;;
864# jms)
865# debug-print "java-pkg_need: adding jms dependencies"
866# newdepstr="|| ( dev-java/sun-jms dev-java/openjms )"
867# ;;
868# *)
869# die "Invalid virtual: ${virtual}"
870# esac
871#
872# export JAVA_PKG_VNEED="${JAVA_PKG_VNEED} ${virtual}"
873#
874# if [[ -n ${useflag} ]]; then
875# depstr="${depstr} ${useflag}? ( ${newdepstr} )"
876# else
877# depstr="${depstr} ${newdepstr}"
878# fi
879# done 1335 done
880# 1336 [[ "${found}" ]]
881# [[ -z ${JAVA_PKG_NV_DEPEND} ]] && export JAVA_PKG_NV_DEPEND="${DEPEND}" 1337 return $?
882# [[ -z ${JAVA_PKG_NV_RDEPEND} ]] && export JAVA_PKG_NV_RDEPEND="${RDEPEND}" 1338}
883#
884# export DEPEND="${DEPEND} ${depstr}"
885# export RDEPEND="${RDEPEND} ${depstr}"
886#}
887 1339
1340# @FUNCTION: java-pkg_ensure-no-bundled-jars
1341# @DESCRIPTION:
1342# Try to locate bundled jar files in ${WORKDIR} and die if found.
888# 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
889# TODO document 1344# to system jar files or bundled jars removed.
890java-pkg_ensure-no-bundled-jars() { 1345java-pkg_ensure-no-bundled-jars() {
891 debug-print-function ${FUNCNAME} $* 1346 debug-print-function ${FUNCNAME} $*
892 pushd ${WORKDIR} >/dev/null 2>/dev/null
893 1347
894 local bundled_jars=$(find . -name "*.jar" -type f) 1348 local bundled_jars=$(java-pkg_find-normal-jars)
895 if [[ -n ${bundled_jars} ]]; then 1349 if [[ -n ${bundled_jars} ]]; then
896 echo "Bundled jars found:" 1350 echo "Bundled jars found:"
897 local jar 1351 local jar
898 for jar in ${bundled_jars}; do 1352 for jar in ${bundled_jars}; do
899 echo $(pwd)${jar/./} 1353 echo $(pwd)${jar/./}
900 done 1354 done
901 die "Bundled jars found!" 1355 die "Bundled jars found!"
902
903 fi 1356 fi
904 popd >/dev/null 2>/dev/null
905} 1357}
906 1358
907# ------------------------------------------------------------------------------
908# @internal-function java-pkg_ensure-vm-version-sufficient 1359# @FUNCTION: java-pkg_ensure-vm-version-sufficient
909# 1360# @INTERNAL
1361# @DESCRIPTION:
910# 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.
911#
912# ------------------------------------------------------------------------------
913java-pkg_ensure-vm-version-sufficient() { 1363java-pkg_ensure-vm-version-sufficient() {
914 debug-print-function ${FUNCNAME} $* 1364 debug-print-function ${FUNCNAME} $*
915 1365
916 if ! java-pkg_is-vm-version-sufficient; then 1366 if ! java-pkg_is-vm-version-sufficient; then
917 debug-print "VM is not suffient" 1367 debug-print "VM is not suffient"
919 einfo "Please use java-config -S to set the correct one" 1369 einfo "Please use java-config -S to set the correct one"
920 die "Active Java VM cannot build this package" 1370 die "Active Java VM cannot build this package"
921 fi 1371 fi
922} 1372}
923 1373
924# ------------------------------------------------------------------------------ 1374# @FUNCTION: java-pkg_is-vm-version-sufficient
925# @internal-function java-pkg_is-vm-version-sufficient 1375# @INTERNAL
926# 1376# @DESCRIPTION:
927# @return zero - VM is sufficient 1377# @RETURN: zero - VM is sufficient; non-zero - VM is not sufficient
928# @return non-zero - VM is not sufficient
929# ------------------------------------------------------------------------------
930java-pkg_is-vm-version-sufficient() { 1378java-pkg_is-vm-version-sufficient() {
931 debug-print-function ${FUNCNAME} $* 1379 debug-print-function ${FUNCNAME} $*
932 1380
933 depend-java-query --is-sufficient "${DEPEND}" > /dev/null 1381 depend-java-query --is-sufficient "${DEPEND}" > /dev/null
934 return $? 1382 return $?
935} 1383}
936 1384
937# ------------------------------------------------------------------------------ 1385# @FUNCTION: java-pkg_ensure-vm-version-eq
938# @internal-function java-pkg_ensure-vm-version-eq 1386# @INTERNAL
939# 1387# @DESCRIPTION:
940# 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.
941# 1389#
942# @param $@ - Desired VM version to ensure 1390# @param $@ - Desired VM version to ensure
943# ------------------------------------------------------------------------------
944java-pkg_ensure-vm-version-eq() { 1391java-pkg_ensure-vm-version-eq() {
945 debug-print-function ${FUNCNAME} $* 1392 debug-print-function ${FUNCNAME} $*
946 1393
947 if ! java-pkg_is-vm-version-eq $@ ; then 1394 if ! java-pkg_is-vm-version-eq $@ ; then
948 debug-print "VM is not suffient" 1395 debug-print "VM is not suffient"
950 einfo "Please use java-config -S to set the correct one" 1397 einfo "Please use java-config -S to set the correct one"
951 die "Active Java VM too old" 1398 die "Active Java VM too old"
952 fi 1399 fi
953} 1400}
954 1401
955# ------------------------------------------------------------------------------ 1402# @FUNCTION: java-pkg_is-vm-version-eq
956# @internal-function java-pkg_is-vm-version-eq 1403# @USAGE: <version>
957# 1404# @INTERNAL
958# @param $@ - VM version to compare current VM to 1405# @RETURN: zero - VM versions are equal; non-zero - VM version are not equal
959# @return zero - VM versions are equal
960# @return non-zero - VM version are not equal
961# ------------------------------------------------------------------------------
962java-pkg_is-vm-version-eq() { 1406java-pkg_is-vm-version-eq() {
963 debug-print-function ${FUNCNAME} $* 1407 debug-print-function ${FUNCNAME} $*
964 1408
965 local needed_version="$@" 1409 local needed_version="$@"
966 1410
983 return 1 1427 return 1
984 fi 1428 fi
985 fi 1429 fi
986} 1430}
987 1431
988# ------------------------------------------------------------------------------ 1432# @FUNCTION: java-pkg_ensure-vm-version-ge
989# @internal-function java-pkg_ensure-vm-version-ge 1433# @INTERNAL
990# 1434# @DESCRIPTION:
991# 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
992# 1436#
993# @param $@ - VM version to compare current to 1437# @param $@ - VM version to compare current to
994# ------------------------------------------------------------------------------
995java-pkg_ensure-vm-version-ge() { 1438java-pkg_ensure-vm-version-ge() {
996 debug-print-function ${FUNCNAME} $* 1439 debug-print-function ${FUNCNAME} $*
997 1440
998 if ! java-pkg_is-vm-version-ge "$@" ; then 1441 if ! java-pkg_is-vm-version-ge "$@" ; then
999 debug-print "vm is not suffient" 1442 debug-print "vm is not suffient"
1000 eerror "This package requires a Java VM version >= $@" 1443 eerror "This package requires a Java VM version >= $@"
1001 einfo "Please use java-config -S to set the correct one" 1444 einfo "Please use java-config -S to set the correct one"
1002 die "Active Java VM too old" 1445 die "Active Java VM too old"
1003 fi 1446 fi
1004} 1447}
1005 1448
1006# ------------------------------------------------------------------------------ 1449# @FUNCTION: java-pkg_is-vm-version-ge
1007# @internal-function java-pkg_is-vm-version-ge 1450# @INTERNAL
1008# 1451# @DESCRIPTION:
1452# @CODE
1453# Parameters:
1009# @param $@ - VM version to compare current VM to 1454# $@ - VM version to compare current VM to
1455# @CODE
1010# @return zero - current VM version is greater than checked version 1456# @RETURN: zero - current VM version is greater than checked version;
1011# @return non-zero - current VM version is not greater than checked version 1457# non-zero - current VM version is not greater than checked version
1012# ------------------------------------------------------------------------------
1013java-pkg_is-vm-version-ge() { 1458java-pkg_is-vm-version-ge() {
1014 debug-print-function ${FUNCNAME} $* 1459 debug-print-function ${FUNCNAME} $*
1015 1460
1016 local needed_version=$@ 1461 local needed_version=$@
1017 local vm_version=$(java-pkg_get-vm-version) 1462 local vm_version=$(java-pkg_get-vm-version)
1027 return 1 1472 return 1
1028 fi 1473 fi
1029 fi 1474 fi
1030} 1475}
1031 1476
1032# ------------------------------------------------------------------------------ 1477java-pkg_set-current-vm() {
1033# @ebuild-function java-pkg_get-source 1478 export GENTOO_VM=${1}
1034# 1479}
1480
1481java-pkg_get-current-vm() {
1482 echo ${GENTOO_VM}
1483}
1484
1485java-pkg_current-vm-matches() {
1486 has $(java-pkg_get-current-vm) ${@}
1487 return $?
1488}
1489
1490# @FUNCTION: java-pkg_get-source
1491# @DESCRIPTION:
1035# Determines what source version should be used, for passing to -source. 1492# Determines what source version should be used, for passing to -source.
1036# 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
1037# 1494#
1038# @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
1039# ------------------------------------------------------------------------------
1040java-pkg_get-source() { 1496java-pkg_get-source() {
1041 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}")}
1042} 1498}
1043 1499
1044# ------------------------------------------------------------------------------ 1500# @FUNCTION: java-pkg_get-target
1045# @ebuild-function java-pkg_get-target 1501# @DESCRIPTION:
1046#
1047# Determines what target version should be used, for passing to -target. 1502# Determines what target version should be used, for passing to -target.
1048# 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
1049# version of your JDK. 1504# version of your JDK.
1050# Remember doing this will mostly like cause things to break.
1051# Doesn't allow it to be lower then the one in depend.
1052# Doesn't allow it to be higher then the active vm.
1053# 1505#
1054# @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
1055# ------------------------------------------------------------------------------
1056java-pkg_get-target() { 1507java-pkg_get-target() {
1057 local min=$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")
1058 if [[ -n "${JAVA_PKG_WANT_TARGET}" ]]; then
1059 local max="$(java-config --select-vm "${GENTOO_VM}" -g PROVIDES_VERSION)"
1060 if version_is_at_least "${min}" "${JAVA_PKG_WANT_TARGET}" && version_is_at_least "${JAVA_PKG_WANT_TARGET}" "${max}"; then
1061 echo ${JAVA_PKG_WANT_TARGET}
1062 else
1063 echo ${min}
1064 fi
1065 else
1066 echo ${min}
1067 fi
1068
1069 #echo ${JAVA_PKG_WANT_TARGET:-$(depend-java-query --get-lowest "${DEPEND}")} 1508 echo ${JAVA_PKG_WANT_TARGET:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1070} 1509}
1071 1510
1511# @FUNCTION: java-pkg_get-javac
1512# @DESCRIPTION:
1513# Returns the compiler executable
1072java-pkg_get-javac() { 1514java-pkg_get-javac() {
1073 debug-print-function ${FUNCNAME} $* 1515 debug-print-function ${FUNCNAME} $*
1074 1516
1075 java-pkg_init-compiler_ 1517
1076 local compiler="${GENTOO_COMPILER}" 1518 local compiler="${GENTOO_COMPILER}"
1077 1519
1078 local compiler_executable 1520 local compiler_executable
1079 if [[ "${compiler}" = "javac" ]]; then 1521 if [[ "${compiler}" = "javac" ]]; then
1080 # nothing fancy needs to be done for javac 1522 # nothing fancy needs to be done for javac
1088 unset JAVAC 1530 unset JAVAC
1089 # try to get value of JAVAC 1531 # try to get value of JAVAC
1090 compiler_executable="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${JAVAC})" 1532 compiler_executable="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${JAVAC})"
1091 export JAVAC=${old_javac} 1533 export JAVAC=${old_javac}
1092 1534
1093 [[ -z ${compiler_executable} ]] && die "JAVAC is empty or undefined in ${compiler_env}" 1535 if [[ -z ${compiler_executable} ]]; then
1094 1536 echo "JAVAC is empty or undefined in ${compiler_env}"
1537 return 1
1538 fi
1539
1095 # check that it's executable 1540 # check that it's executable
1096 if [[ ! -x ${compiler_executable} ]]; then 1541 if [[ ! -x ${compiler_executable} ]]; then
1097 eerror "Could not find ${compiler_executable}!"
1098 die "${compiler_executable} doesn't exist, or isn't executable" 1542 echo "${compiler_executable} doesn't exist, or isn't executable"
1543 return 1
1099 fi 1544 fi
1100 else 1545 else
1101 eerror "Could not find environment file for ${compiler}" 1546 echo "Could not find environment file for ${compiler}"
1102 die "Could not find ${compiler_env}" 1547 return 1
1103 fi 1548 fi
1104 fi 1549 fi
1105 echo ${compiler_executable} 1550 echo ${compiler_executable}
1106} 1551}
1107 1552
1108# ------------------------------------------------------------------------------ 1553# @FUNCTION: java-pkg_javac-args
1109# @ebuild-function java-pkg_javac-args 1554# @DESCRIPTION:
1110#
1111# 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
1112# to know what -source/-target to use. 1556# to know what -source/-target to use.
1113# 1557#
1114# @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
1115# ------------------------------------------------------------------------------
1116java-pkg_javac-args() { 1559java-pkg_javac-args() {
1117 debug-print-function ${FUNCNAME} $* 1560 debug-print-function ${FUNCNAME} $*
1118 1561
1119 local want_source="$(java-pkg_get-source)" 1562 local want_source="$(java-pkg_get-source)"
1120 local want_target="$(java-pkg_get-target)" 1563 local want_target="$(java-pkg_get-target)"
1121 1564
1122 local source_str="-source ${want_source}" 1565 local source_str="-source ${want_source}"
1123 local target_str="-target ${want_target}" 1566 local target_str="-target ${want_target}"
1124 1567
1125 debug-print "want source: ${want_source}" 1568 debug-print "want source: ${want_source}"
1126 debug-print "want target: ${want_target}" 1569 debug-print "want target: ${want_target}"
1127 1570
1128 if [[ -z "${want_source}" || -z "${want_target}" ]]; then 1571 if [[ -z "${want_source}" || -z "${want_target}" ]]; then
1129 debug-print "could not find valid -source/-target values" 1572 debug-print "could not find valid -source/-target values for javac"
1130 die "Could not find valid -source/-target values" 1573 echo "Could not find valid -source/-target values for javac"
1574 return 1
1131 else 1575 else
1132 if java-pkg_is-vm-version-ge "1.4"; then 1576 if java-pkg_is-vm-version-ge "1.4"; then
1133 echo "${source_str} ${target_str}" 1577 echo "${source_str} ${target_str}"
1134 else 1578 else
1135 echo "${target_str}" 1579 echo "${target_str}"
1136 fi 1580 fi
1137 fi 1581 fi
1138} 1582}
1139 1583
1140# TODO document 1584# @FUNCTION: java-pkg_get-jni-cflags
1585# @DESCRIPTION:
1586# Echos the CFLAGS for JNI compilations
1141java-pkg_get-jni-cflags() { 1587java-pkg_get-jni-cflags() {
1142 local flags="-I${JAVA_HOME}/include" 1588 local flags="-I${JAVA_HOME}/include"
1143 1589
1144 # TODO figure out how to cope with other things than linux... 1590 local platform="linux"
1591 use elibc_FreeBSD && platform="freebsd"
1592
1593 # TODO do a check that the directories are valid
1145 flags="${flags} -I${JAVA_HOME}/include/linux" 1594 flags="${flags} -I${JAVA_HOME}/include/${platform}"
1146 1595
1147 echo ${flags} 1596 echo ${flags}
1148} 1597}
1149 1598
1150# ------------------------------------------------------------------------------ 1599java-pkg_ensure-gcj() {
1151# @section-end helper 1600 # was enforcing sys-devel/gcc[gcj]
1152# ------------------------------------------------------------------------------ 1601 die "${FUNCNAME} was removed. Use use-deps available as of EAPI 2 instead. #261562"
1602}
1153 1603
1154# ------------------------------------------------------------------------------ 1604java-pkg_ensure-test() {
1155# @section-begin build 1605 # was enforcing USE=test if FEATURES=test
1156# @section-summary Build functions 1606 die "${FUNCNAME} was removed. Package mangers handle this already. #278965"
1157# 1607}
1158# These are some functions for building a package. In particular, it consists of
1159# wrappers for javac and ant.
1160# ------------------------------------------------------------------------------
1161 1608
1162# ------------------------------------------------------------------------------ 1609# @FUNCTION: java-pkg_register-ant-task
1163# @ebuild-function eant 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.
1164# 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}"
1638 fi
1639 shift 2
1640 done
1641
1642 local TASK_NAME="${1:-${JAVA_PKG_NAME}}"
1643
1644 dodir /usr/share/ant/${TASKS_DIR}
1645 touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}"
1646}
1647
1648# @FUNCTION: java-pkg_ant-tasks-depend
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.
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:
1165# 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
1166# compiler. 1809# compiler. Will also set proper ANT_TASKS from the variable ANT_TASKS,
1810# variables:
1167# 1811#
1168# ------------------------------------------------------------------------------ 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
1169eant() { 1821eant() {
1170 debug-print-function ${FUNCNAME} $* 1822 debug-print-function ${FUNCNAME} $*
1171 1823
1172 local antflags 1824 if [[ ${EBUILD_PHASE} = compile ]]; 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"
1831 java-pkg_announce-qa-violation "${msg}"
1832 fi
1833
1834 local antflags="-Dnoget=true -Dmaven.mode.offline=true -Dbuild.sysclasspath=ignore"
1835
1173 java-pkg_init-compiler_ 1836 java-pkg_init-compiler_
1174 local compiler="${GENTOO_COMPILER}" 1837 local compiler="${GENTOO_COMPILER}"
1175 1838
1176 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}" 1839 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1177
1178 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})"
1179 if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then 1841 if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then
1180 die "ANT_BUILD_COMPILER undefined in ${compiler_env}" 1842 die "ANT_BUILD_COMPILER undefined in ${compiler_env}"
1181 fi 1843 fi
1182 1844
1183 if [[ ${compiler} != "javac" ]]; then 1845 if [[ ${compiler} != "javac" ]]; then
1184 antflags="-Dbuild.compiler=${build_compiler}" 1846 antflags="${antflags} -Dbuild.compiler=${build_compiler}"
1185 # Figure out any extra stuff to put on the classpath for compilers aside 1847 # Figure out any extra stuff to put on the classpath for compilers aside
1186 # from javac 1848 # from javac
1187 # ANT_BUILD_COMPILER_DEPS should be something that could be passed to 1849 # ANT_BUILD_COMPILER_DEPS should be something that could be passed to
1188 # java-config -p 1850 # java-config -p
1189 local build_compiler_deps="$(source ${JAVA_PKG_COMPILER_DIR}/${compiler} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER_DEPS})" 1851 local build_compiler_deps="$(source ${JAVA_PKG_COMPILER_DIR}/${compiler} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER_DEPS})"
1190 if [[ -n ${build_compiler_deps} ]]; then 1852 if [[ -n ${build_compiler_deps} ]]; then
1191 antflags="${antflags} -lib $(java-config -p ${build_compiler_deps})" 1853 antflags="${antflags} -lib $(java-config -p ${build_compiler_deps})"
1192 fi 1854 fi
1193 fi 1855 fi
1194 1856
1195 if [[ -n ${JAVA_PKG_DEBUG} ]]; then 1857 for arg in "${@}"; do
1196 antflags="${antflags} -debug" 1858 if [[ ${arg} = -lib ]]; then
1859 if is-java-strict; then
1860 eerror "You should not use the -lib argument to eant because it will fail"
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
1197 fi 1870 fi
1198 1871 done
1872
1873 # parse WANT_ANT_TASKS for atoms
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}\""
1932 fi
1933
1199 [[ -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} ${@}"
1200 ant ${antflags} "${@}" || die "eant failed" 1936 ant ${antflags} "${@}" || die "eant failed"
1201
1202} 1937}
1203 1938
1204# ------------------------------------------------------------------------------ 1939# @FUNCTION: ejavac
1205# @ebuild-function ejavac 1940# @USAGE: <javac_arguments>
1206# 1941# @DESCRIPTION:
1207# Javac wrapper function. Will use the appropriate compiler, based on 1942# Javac wrapper function. Will use the appropriate compiler, based on
1208# /etc/java-config/compilers.conf 1943# /etc/java-config/compilers.conf
1209#
1210# @param $@ - Arguments to be passed to the compiler
1211# ------------------------------------------------------------------------------
1212ejavac() { 1944ejavac() {
1213 debug-print-function ${FUNCNAME} $* 1945 debug-print-function ${FUNCNAME} $*
1214 1946
1947 java-pkg_init-compiler_
1948
1949 local compiler_executable
1215 local compiler_executable=$(java-pkg_get-javac) 1950 compiler_executable=$(java-pkg_get-javac)
1951 if [[ ${?} != 0 ]]; then
1952 eerror "There was a problem determining compiler: ${compiler_executable}"
1953 die "get-javac failed"
1954 fi
1216 1955
1956 local javac_args
1957 javac_args="$(java-pkg_javac-args)"
1958 if [[ ${?} != 0 ]]; then
1959 eerror "There was a problem determining JAVACFLAGS: ${javac_args}"
1960 die "java-pkg_javac-args failed"
1961 fi
1962
1217 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} $(java-pkg_javac-args) "${@}" 1963 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} ${javac_args} "${@}"
1218 ${compiler_executable} $(java-pkg_javac-args) "${@}" || die "ejavac failed" 1964 ${compiler_executable} ${javac_args} "${@}" || die "ejavac failed"
1219} 1965}
1220 1966
1221# ------------------------------------------------------------------------------ 1967# @FUNCTION: ejavadoc
1222# @ebuild-function java-pkg_filter-compiler 1968# @USAGE: <javadoc_arguments>
1223# 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:
1224# 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.
1225# Basically, it just appends onto JAVA_PKG_FILTER_COMPILER 1988# Basically, it just appends onto JAVA_PKG_FILTER_COMPILER
1226#
1227# @param $@ - compilers to filter
1228# ------------------------------------------------------------------------------
1229java-pkg_filter-compiler() { 1989java-pkg_filter-compiler() {
1230 JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@" 1990 JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@"
1231} 1991}
1232 1992
1233# ------------------------------------------------------------------------------ 1993# @FUNCTION: java-pkg_force-compiler
1234# @ebuild-function use_doc 1994# @USAGE: <compiler(s)_to_force>
1995# @DESCRIPTION:
1996# Used to force the use of particular compilers. Should be used in src_compile.
1997# A common use of this would be to force ecj-3.1 to be used on amd64, to avoid
1998# OutOfMemoryErrors that may come up.
1999java-pkg_force-compiler() {
2000 JAVA_PKG_FORCE_COMPILER="$@"
2001}
2002
2003# @FUNCTION: use_doc
2004# @DESCRIPTION:
1235# 2005#
1236# 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,
1237# 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.
1238# 2008#
1239# 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'
1240# 2013#
2014# Examples:
1241# Example: build javadocs by calling 'javadoc' target 2015# build javadocs by calling 'javadoc' target
1242# eant $(use_doc) 2016# eant $(use_doc)
2017#
1243# Example: build javadocs by calling 'apidoc' target 2018# build javadocs by calling 'apidoc' target
1244# eant $(use_doc apidoc) 2019# eant $(use_doc apidoc)
1245# 2020# @CODE
1246# @param $@ - Option value to return. Defaults to 'javadoc'
1247# @return string - Name of the target to create javadocs 2021# @RETURN string - Name of the target to create javadocs
1248# ------------------------------------------------------------------------------
1249use_doc() { 2022use_doc() {
1250 use doc && echo ${@:-javadoc} 2023 use doc && echo ${@:-javadoc}
1251} 2024}
1252 2025
1253# ------------------------------------------------------------------------------
1254# @section-end build
1255# ------------------------------------------------------------------------------
1256
1257# ------------------------------------------------------------------------------
1258# @section-begin internal
1259# @section-summary Internal functions
1260#
1261# Do __NOT__ use any of these from an ebuild! These are only to be used from
1262# within the java eclasses.
1263# ------------------------------------------------------------------------------
1264 2026
1265# ----------------------------------------------------------------------------- 2027# @FUNCTION: java-pkg_init
1266# @function-internal java-pkg_init 2028# @INTERNAL
1267# 2029# @DESCRIPTION:
1268# 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
1269# 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
1270# 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
1271# internally. And most importantly, it'll switch the VM if necessary. 2033# internally. And most importantly, it'll switch the VM if necessary.
1272# 2034#
1273# 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
1274# call it during each of the phases of the merge process. 2036# call it during each of the phases of the merge process.
1275#
1276# -----------------------------------------------------------------------------
1277java-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
1278 unset JAVAC 2046 unset JAVAC
1279 unset JAVA_HOME 2047 unset JAVA_HOME
1280 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
1281 java-pkg_switch-vm 2082 java-pkg_switch-vm
1282 PATH=${JAVA_HOME}/bin:${PATH} 2083 PATH=${JAVA_HOME}/bin:${PATH}
1283 2084
1284 # TODO we will probably want to set JAVAC and JAVACFLAGS 2085 # TODO we will probably want to set JAVAC and JAVACFLAGS
1285 2086
1286 # Do some QA checks 2087 # Do some QA checks
1287 java-pkg_check-jikes 2088 java-pkg_check-jikes
1288 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
2092
1289 # When users have crazy classpaths some packages can fail to compile. 2093 # When users have crazy classpaths some packages can fail to compile.
1290 # and everything should work with empty CLASSPATH. 2094 # and everything should work with empty CLASSPATH.
1291 # This also helps prevent unexpected dependencies on random things 2095 # This also helps prevent unexpected dependencies on random things
1292 # from the CLASSPATH. 2096 # from the CLASSPATH.
1293 unset CLASSPATH 2097 export CLASSPATH=
1294}
1295 2098
1296# ------------------------------------------------------------------------------ 2099 # Unset external ANT_ stuff
1297# @function-internal java-pkg-init-compiler_ 2100 export ANT_TASKS=
1298# 2101 export ANT_OPTS=
2102 export ANT_RESPECT_JAVA_HOME=
2103}
2104
2105# @FUNCTION: java-pkg-init-compiler_
2106# @INTERNAL
2107# @DESCRIPTION:
1299# 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
1300# 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
1301# COMPILERS variable defined there. 2110# COMPILERS variable defined there.
1302# 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
1303# 2112#
1304# It will go through the list of compilers, and verify that it supports the 2113# It will go through the list of compilers, and verify that it supports the
1305# target and source that are needed. If it is not suitable, then the next 2114# target and source that are needed. If it is not suitable, then the next
1306# compiler is checked. When JAVA_PKG_FORCE_COMPILER is defined, this checking 2115# compiler is checked. When JAVA_PKG_FORCE_COMPILER is defined, this checking
1307# isn't done. 2116# isn't done.
1308# 2117#
1314# 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
1315# 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
1316# by the current VM. 2125# by the current VM.
1317# 2126#
1318# 2127#
1319# @return name of the compiler to use 2128# @RETURN name of the compiler to use
1320# ------------------------------------------------------------------------------
1321java-pkg_init-compiler_() { 2129java-pkg_init-compiler_() {
1322 debug-print-function ${FUNCNAME} $* 2130 debug-print-function ${FUNCNAME} $*
1323 2131
1324 if [[ -n ${GENTOO_COMPILER} ]]; then 2132 if [[ -n ${GENTOO_COMPILER} ]]; then
1325 debug-print "GENTOO_COMPILER already set" 2133 debug-print "GENTOO_COMPILER already set"
1330 if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then 2138 if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
1331 compilers="$(source ${JAVA_PKG_COMPILERS_CONF} 1>/dev/null 2>&1; echo ${COMPILERS})" 2139 compilers="$(source ${JAVA_PKG_COMPILERS_CONF} 1>/dev/null 2>&1; echo ${COMPILERS})"
1332 else 2140 else
1333 compilers=${JAVA_PKG_FORCE_COMPILER} 2141 compilers=${JAVA_PKG_FORCE_COMPILER}
1334 fi 2142 fi
1335 2143
1336 debug-print "Read \"${compilers}\" from ${JAVA_PKG_COMPILERS_CONF}" 2144 debug-print "Read \"${compilers}\" from ${JAVA_PKG_COMPILERS_CONF}"
1337 2145
1338 # Figure out if we should announce what compiler we're using 2146 # Figure out if we should announce what compiler we're using
1339 local compiler 2147 local compiler
1340 for compiler in ${compilers}; do 2148 for compiler in ${compilers}; do
1343 if [[ ${compiler} = "javac" ]]; then 2151 if [[ ${compiler} = "javac" ]]; then
1344 debug-print "Found javac... breaking" 2152 debug-print "Found javac... breaking"
1345 export GENTOO_COMPILER="javac" 2153 export GENTOO_COMPILER="javac"
1346 break 2154 break
1347 fi 2155 fi
1348 2156
1349 if has ${compiler} ${JAVA_PKG_FILTER_COMPILER}; then 2157 if has ${compiler} ${JAVA_PKG_FILTER_COMPILER}; then
1350 if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then 2158 if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
1351 einfo "Filtering ${compiler}" 2159 einfo "Filtering ${compiler}"
1352 continue 2160 continue
1353 fi 2161 fi
1354 fi 2162 fi
1355 2163
1356 # for non-javac, we need to make sure it supports the right target and 2164 # for non-javac, we need to make sure it supports the right target and
1357 # source 2165 # source
1358 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}" 2166 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1359 if [[ -f ${compiler_env} ]]; then 2167 if [[ -f ${compiler_env} ]]; then
1360 local desired_target="$(java-pkg_get-target)" 2168 local desired_target="$(java-pkg_get-target)"
1389 done 2197 done
1390 2198
1391 # If it hasn't been defined already, default to javac 2199 # If it hasn't been defined already, default to javac
1392 if [[ -z ${GENTOO_COMPILER} ]]; then 2200 if [[ -z ${GENTOO_COMPILER} ]]; then
1393 if [[ -n ${compilers} ]]; then 2201 if [[ -n ${compilers} ]]; then
1394 einfo "No suitable compiler found: defaulting javac for compilation" 2202 einfo "No suitable compiler found: defaulting to JDK default for compilation"
1395 else 2203 else
1396 # probably don't need to notify users about the default. 2204 # probably don't need to notify users about the default.
1397 :;#einfo "Defaulting to javac for compilation" 2205 :;#einfo "Defaulting to javac for compilation"
1398 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
1399 export GENTOO_COMPILER=javac 2210 export GENTOO_COMPILER=javac
2211 fi
1400 else 2212 else
1401 einfo "Using ${GENTOO_COMPILER} for compilation" 2213 einfo "Using ${GENTOO_COMPILER} for compilation"
1402 fi 2214 fi
1403 2215
1404} 2216}
1405 2217
1406# ------------------------------------------------------------------------------ 2218# @FUNCTION: init_paths_
1407# @internal-function init_paths_ 2219# @INTERNAL
1408# 2220# @DESCRIPTION:
1409# 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
1410# to determine where things will eventually get installed. 2222# to determine where things will eventually get installed.
1411# ------------------------------------------------------------------------------
1412java-pkg_init_paths_() { 2223java-pkg_init_paths_() {
1413 debug-print-function ${FUNCNAME} $* 2224 debug-print-function ${FUNCNAME} $*
1414 2225
1415 local pkg_name 2226 local pkg_name
1416 if [[ "$SLOT" == "0" ]] ; then 2227 if [[ "${SLOT%/*}" == "0" ]] ; then
1417 JAVA_PKG_NAME="${PN}" 2228 JAVA_PKG_NAME="${PN}"
1418 else 2229 else
1419 JAVA_PKG_NAME="${PN}-${SLOT}" 2230 JAVA_PKG_NAME="${PN}-${SLOT%/*}"
1420 fi 2231 fi
1421 2232
1422 JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}" 2233 JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}"
1423 JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/" 2234 JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/"
1424 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}"
1425 2238
1426 [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib" 2239 [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib"
1427 [[ -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}"
1428 [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps" 2241 [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps"
1429
1430 2242
1431 # TODO maybe only print once? 2243 # TODO maybe only print once?
1432 debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}" 2244 debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}"
1433 debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}" 2245 debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}"
1434 debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}" 2246 debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}"
1435 debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}" 2247 debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}"
1436 debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}" 2248 debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}"
1437} 2249}
1438 2250
1439# ------------------------------------------------------------------------------ 2251# @FUNCTION: java-pkg_do_write_
1440# @internal-function java-pkg_do_write_ 2252# @INTERNAL
1441# 2253# @DESCRIPTION:
1442# Writes the package.env out to disk. 2254# Writes the package.env out to disk.
1443# 2255#
1444# ------------------------------------------------------------------------------
1445# TODO change to do-write, to match everything else 2256# TODO change to do-write, to match everything else
1446java-pkg_do_write_() { 2257java-pkg_do_write_() {
2258 debug-print-function ${FUNCNAME} $*
2259 java-pkg_init_paths_
1447 # Create directory for package.env 2260 # Create directory for package.env
1448 dodir "${JAVA_PKG_SHAREPATH}" 2261 dodir "${JAVA_PKG_SHAREPATH}"
1449 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
1450 # Create package.env 2265 # Create package.env
1451 ( 2266 (
1452 echo "DESCRIPTION=\"${DESCRIPTION}\"" 2267 echo "DESCRIPTION=\"${DESCRIPTION}\""
1453 echo "GENERATION=\"2\"" 2268 echo "GENERATION=\"2\""
2269 echo "SLOT=\"${SLOT}\""
2270 echo "CATEGORY=\"${CATEGORY}\""
2271 echo "PVR=\"${PVR}\""
1454 2272
1455 [[ -n "${JAVA_PKG_CLASSPATH}" ]] && echo "CLASSPATH=\"${JAVA_PKG_CLASSPATH}\"" 2273 [[ -n "${JAVA_PKG_CLASSPATH}" ]] && echo "CLASSPATH=\"${JAVA_PKG_CLASSPATH}\""
1456 [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\"" 2274 [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\""
1457 [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\"" 2275 [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\""
1458 [[ -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' ':')\""
1459 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' ':')\""
1460 ) > "${JAVA_PKG_ENV}" 2283 ) > "${JAVA_PKG_ENV}"
1461 2284
1462 # register target/source 2285 # register target/source
1463 local target="$(java-pkg_get-target)" 2286 local target="$(java-pkg_get-target)"
1464 local source="$(java-pkg_get-source)" 2287 local source="$(java-pkg_get-source)"
1465 [[ -n ${target} ]] && echo "TARGET=\"${target}\"" >> "${JAVA_PKG_ENV}" 2288 [[ -n ${target} ]] && echo "TARGET=\"${target}\"" >> "${JAVA_PKG_ENV}"
1466 [[ -n ${source} ]] && echo "SOURCE=\"${source}\"" >> "${JAVA_PKG_ENV}" 2289 [[ -n ${source} ]] && echo "SOURCE=\"${source}\"" >> "${JAVA_PKG_ENV}"
1474 2297
1475 2298
1476 echo "MERGE_VM=\"${GENTOO_VM}\"" >> "${JAVA_PKG_ENV}" 2299 echo "MERGE_VM=\"${GENTOO_VM}\"" >> "${JAVA_PKG_ENV}"
1477 [[ -n ${GENTOO_COMPILER} ]] && echo "MERGE_COMPILER=\"${GENTOO_COMPILER}\"" >> "${JAVA_PKG_ENV}" 2300 [[ -n ${GENTOO_COMPILER} ]] && echo "MERGE_COMPILER=\"${GENTOO_COMPILER}\"" >> "${JAVA_PKG_ENV}"
1478 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
1479 # Strip unnecessary leading and trailing colons 2310 # Strip unnecessary leading and trailing colons
1480 # TODO try to cleanup if possible 2311 # TODO try to cleanup if possible
1481 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."
1482 fi 2317 fi
1483} 2318}
1484 2319
1485 2320# @FUNCTION: java-pkg_record-jar_
1486# ------------------------------------------------------------------------------ 2321# @INTERNAL
1487# @internal-function java-pkg_record-jar_ 2322# @DESCRIPTION:
1488#
1489# Record a dependency to the package.env 2323# Record an (optional) dependency to the package.env
1490# 2324# @CODE
1491# ------------------------------------------------------------------------------ 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
1492JAVA_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"
1493 2334
1494java-pkg_record-jar_() { 2335java-pkg_record-jar_() {
1495 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
1496 2343
1497 local pkg=${1} jar=${2} append 2344 local pkg=${1} jar=${2} append
1498 if [[ -z "${jar}" ]]; then 2345 if [[ -z "${jar}" ]]; then
1499 append="${pkg}" 2346 append="${pkg}"
1500 else 2347 else
1501 append="$(basename ${jar})@${pkg}" 2348 append="$(basename ${jar})@${pkg}"
1502 fi 2349 fi
1503 2350
1504 echo ${append} >> ${JAVA_PKG_DEPEND} 2351 echo "${append}" >> "${depend_file}"
1505} 2352}
1506 2353
1507# ------------------------------------------------------------------------------ 2354# @FUNCTION: java-pkg_append_
1508# @internal-function java-pkg_append_ 2355# @INTERNAL
1509# 2356# @DESCRIPTION:
1510# Appends a value to a variable 2357# Appends a value to a variable
1511# 2358#
1512# Example: java-pkg_append_ CLASSPATH foo.jar 2359# @CODE
2360# Parameters:
1513# @param $1 variable name to modify 2361# $1 variable name to modify
1514# @param $2 value to append 2362# $2 value to append
1515# ------------------------------------------------------------------------------ 2363#
2364# Examples:
2365# java-pkg_append_ CLASSPATH foo.jar
2366# @CODE
1516java-pkg_append_() { 2367java-pkg_append_() {
1517 debug-print-function ${FUNCNAME} $* 2368 debug-print-function ${FUNCNAME} $*
1518 2369
1519 local var="${1}" value="${2}" 2370 local var="${1}" value="${2}"
1520 if [[ -z "${!var}" ]] ; then 2371 if [[ -z "${!var}" ]] ; then
1531 [[ -z ${haveit} ]] && export ${var}="${!var}:${value}" 2382 [[ -z ${haveit} ]] && export ${var}="${!var}:${value}"
1532 IFS=${oldIFS} 2383 IFS=${oldIFS}
1533 fi 2384 fi
1534} 2385}
1535 2386
1536# ------------------------------------------------------------------------------ 2387# @FUNCTION: java-pkg_expand_dir_
1537# @internal-function java-pkg_expand_dir_ 2388# @INTERNAL
1538# 2389# @DESCRIPTION:
1539# 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:
1540# @param $1 - file/directory to find parent directory for 2393# $1 - file/directory to find parent directory for
2394# @CODE
1541# @return - path to $1's parent directory 2395# @RETURN: path to $1's parent directory
1542# ------------------------------------------------------------------------------
1543java-pkg_expand_dir_() { 2396java-pkg_expand_dir_() {
1544 pushd "$(dirname "${1}")" >/dev/null 2>&1 2397 pushd "$(dirname "${1}")" >/dev/null 2>&1
1545 pwd 2398 pwd
1546 popd >/dev/null 2>&1 2399 popd >/dev/null 2>&1
1547} 2400}
1548 2401
1549# ------------------------------------------------------------------------------ 2402# @FUNCTION: java-pkg_func-exists
1550# @internal-function java-pkg_func-exists 2403# @INTERNAL
1551# 2404# @DESCRIPTION:
1552# Does the indicated function exist? 2405# Does the indicated function exist?
1553# 2406# @RETURN: 0 - function is declared, 1 - function is undeclared
1554# @return 0 - function is declared
1555# @return 1 - function is undeclared
1556# ------------------------------------------------------------------------------
1557java-pkg_func-exists() { 2407java-pkg_func-exists() {
1558 if [[ -n "$(declare -f ${1})" ]]; then 2408 declare -F ${1} > /dev/null
1559 return 0
1560 else
1561 return 1
1562 fi
1563} 2409}
1564 2410
1565# ------------------------------------------------------------------------------ 2411# @FUNCTION: java-pkg_setup-vm
1566# @internal-function java-pkg_setup-vm 2412# @INTERNAL
1567# 2413# @DESCRIPTION:
1568# Sets up the environment for a specific VM 2414# Sets up the environment for a specific VM
1569#
1570# ------------------------------------------------------------------------------
1571java-pkg_setup-vm() { 2415java-pkg_setup-vm() {
1572 debug-print-function ${FUNCNAME} $* 2416 debug-print-function ${FUNCNAME} $*
1573 2417
1574 local vendor="$(java-pkg_get-vm-vendor)" 2418 local vendor="$(java-pkg_get-vm-vendor)"
1575 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
1576 addpredict "/dev/random" 2420 addpredict "/dev/random"
1577 elif [[ "${vendor}" == "ibm" ]]; then 2421 elif [[ "${vendor}" == "ibm" ]]; then
1578 addpredict "/proc/self/maps" 2422 addpredict "/proc/self/maps"
1579 addpredict "/proc/cpuinfo" 2423 addpredict "/proc/cpuinfo"
1580 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"
1581 elif [[ "${vendor}" == "jrockit" ]]; then 2431 elif [[ "${vendor}" == "jrockit" ]]; then
1582 addpredict "/proc/cpuinfo" 2432 addpredict "/proc/cpuinfo"
1583 fi 2433 fi
1584} 2434}
1585 2435
1586# ------------------------------------------------------------------------------ 2436# @FUNCTION: java-pkg_needs-vm
1587# @internal-function java-pkg_needs-vm 2437# @INTERNAL
1588# 2438# @DESCRIPTION:
1589# 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?
1590# 2441#
1591# @return 0 - Package depends on virtual/jdk 2442# @RETURN: 0 - Package depends on virtual/jdk; 1 - Package does not depend on virtual/jdk
1592# @return 1 - Package does not depend on virtual/jdk
1593# ------------------------------------------------------------------------------
1594java-pkg_needs-vm() { 2443java-pkg_needs-vm() {
1595 debug-print-function ${FUNCNAME} $* 2444 debug-print-function ${FUNCNAME} $*
1596 2445
1597 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
1598 return 0 2447 return 0
1599 fi 2448 fi
1600 2449
2450 [[ -n "${JAVA_PKG_WANT_BUILD_VM}" ]] && return 0
2451
1601 return 1 2452 return 1
1602} 2453}
1603 2454
1604# ------------------------------------------------------------------------------ 2455# @FUNCTION: java-pkg_get-current-vm
1605# @internal-function java-pkg_get-current-vm 2456# @INTERNAL
1606#
1607# @return - The current VM being used 2457# @RETURN - The current VM being used
1608# ------------------------------------------------------------------------------
1609java-pkg_get-current-vm() { 2458java-pkg_get-current-vm() {
1610 java-config -f 2459 java-config -f
1611} 2460}
1612 2461
1613# ------------------------------------------------------------------------------ 2462# @FUNCTION: java-pkg_get-vm-vendor
1614# @internal-function java-pkg_get-vm-vendor 2463# @INTERNAL
1615#
1616# @return - The vendor of the current VM 2464# @RETURN - The vendor of the current VM
1617# ------------------------------------------------------------------------------
1618java-pkg_get-vm-vendor() { 2465java-pkg_get-vm-vendor() {
1619 debug-print-function ${FUNCNAME} $* 2466 debug-print-function ${FUNCNAME} $*
1620 2467
1621 local vm="$(java-pkg_get-current-vm)" 2468 local vm="$(java-pkg_get-current-vm)"
1622 vm="${vm/-*/}" 2469 vm="${vm/-*/}"
1623 echo "${vm}" 2470 echo "${vm}"
1624} 2471}
1625 2472
1626# ------------------------------------------------------------------------------ 2473# @FUNCTION: java-pkg_get-vm-version
1627# @internal-function java-pkg_get-vm-version 2474# @INTERNAL
1628#
1629# @return - The version of the current VM 2475# @RETURN - The version of the current VM
1630# ------------------------------------------------------------------------------
1631java-pkg_get-vm-version() { 2476java-pkg_get-vm-version() {
1632 debug-print-function ${FUNCNAME} $* 2477 debug-print-function ${FUNCNAME} $*
1633 2478
1634 java-pkg_get-current-vm | sed -e "s/.*-\([0-9.]\+\).*/\1/" 2479 java-config -g PROVIDES_VERSION
1635} 2480}
1636 2481
1637# ------------------------------------------------------------------------------ 2482# @FUNCTION: java-pkg_build-vm-from-handle
1638# @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.
1639# 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:
1640# 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
1641# verify that the current VM is sufficient. 2517# verify that the current VM is sufficient.
1642# Setup the environment for the VM being used. 2518# Setup the environment for the VM being used.
1643# ------------------------------------------------------------------------------
1644java-pkg_switch-vm() { 2519java-pkg_switch-vm() {
2520 debug-print-function ${FUNCNAME} $*
2521
1645 if java-pkg_needs-vm; then 2522 if java-pkg_needs-vm; then
1646 # Use the VM specified by JAVA_PKG_FORCE_VM 2523 # Use the VM specified by JAVA_PKG_FORCE_VM
1647 if [[ -n ${JAVA_PKG_FORCE_VM} ]]; then 2524 if [[ -n "${JAVA_PKG_FORCE_VM}" ]]; then
1648 # 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...
2526 debug-print "JAVA_PKG_FORCE_VM used: ${JAVA_PKG_FORCE_VM}"
1649 export GENTOO_VM="${JAVA_PKG_FORCE_VM}" 2527 export GENTOO_VM="${JAVA_PKG_FORCE_VM}"
1650 # if we're allowed to switch the vm... 2528 # if we're allowed to switch the vm...
1651 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then 2529 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then
1652 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
1653 if [[ -n ${JAVA_PKG_VNEED} ]]; then 2531 if [[ -n "${JAVA_PKG_WANT_BUILD_VM}" ]]; then
1654 export 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
1655 else 2549 else
2550 debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
1656 export 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
1657 fi 2557 fi
2558 export GENTOO_VM
1658 # otherwise just make sure the current VM is sufficient 2559 # otherwise just make sure the current VM is sufficient
1659 else 2560 else
1660 java-pkg_ensure-vm-version-sufficient 2561 java-pkg_ensure-vm-version-sufficient
1661 fi 2562 fi
1662 debug-print "Using: $(java-config -f)" 2563 debug-print "Using: $(java-config -f)"
1663 2564
1664 java-pkg_setup-vm 2565 java-pkg_setup-vm
1665 2566
1666 export JAVA=$(java-config -java) 2567 export JAVA=$(java-config --java)
1667 export JAVAC=$(java-config -javac) 2568 export JAVAC=$(java-config --javac)
1668 export JAVACFLAGS="$(java-pkg_javac-args)" 2569 JAVACFLAGS="$(java-pkg_javac-args)"
2570 if [[ ${?} != 0 ]]; then
2571 eerror "There was a problem determining JAVACFLAGS: ${JAVACFLAGS}"
2572 die "java-pkg_javac-args failed"
2573 fi
1669 [[ -n ${JAVACFLAGS_EXTRA} ]] && export JAVACFLAGS="${JAVACFLAGS_EXTRA} ${JAVACFLAGS}" 2574 [[ -n ${JAVACFLAGS_EXTRA} ]] && JAVACFLAGS="${JAVACFLAGS_EXTRA} ${JAVACFLAGS}"
2575 export JAVACFLAGS
1670 2576
1671 export JAVA_HOME="$(java-config -g JAVA_HOME)" 2577 export JAVA_HOME="$(java-config -g JAVA_HOME)"
1672 export JDK_HOME=${JAVA_HOME} 2578 export JDK_HOME=${JAVA_HOME}
1673 2579
1674 #TODO If you know a better solution let us know. 2580 #TODO If you know a better solution let us know.
1675 java-pkg_append_ LD_LIBRARY_PATH "$(java-config -g LDPATH)" 2581 java-pkg_append_ LD_LIBRARY_PATH "$(java-config -g LDPATH)"
1676 2582
1677 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
1678 if [[ -n "${JAVA_PKG_DEBUG}" ]] || [[ ! -f "${tann}" ]] ; then 2586 if [[ -n "${JAVA_PKG_DEBUG}" ]] || [[ ! -f "${tann}" ]] ; then
1679 # Add a check for setup/preinst phase... to avoid duplicate outputs
1680 # for when FEATURES=buildpkg
1681 if [[ ${EBUILD_PHASE} != "setup" && ${EBUILD_PHASE} != "preinst" && ${EBUILD_PHASE} != "postinst" ]];
1682 then
1683 einfo "Using: $(java-config -f)" 2587 einfo "Using: $(java-config -f)"
1684 [[ ! -f "${tann}" ]] && touch "${tann}" 2588 [[ ! -f "${tann}" ]] && touch "${tann}"
1685 fi
1686 fi 2589 fi
1687 2590
1688 else 2591 else
1689 [[ -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!!!"
1690 fi 2593 fi
1691} 2594}
1692 2595
1693# ------------------------------------------------------------------------------ 2596# @FUNCTION: java-pkg_die
1694# @internal-function java-pkg_die 2597# @INTERNAL
1695# 2598# @DESCRIPTION:
1696# 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
1697# useful for debugging bugs on bugzilla. 2600# useful for debugging bugs on bugzilla.
1698# ------------------------------------------------------------------------------
1699#register_die_hook java-pkg_die 2601#register_die_hook java-pkg_die
1700if ! hasq java-pkg_die ${EBUILD_DEATH_HOOKS}; then 2602if ! has java-pkg_die ${EBUILD_DEATH_HOOKS}; then
1701 EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die" 2603 EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die"
1702fi 2604fi
1703 2605
1704java-pkg_die() { 2606java-pkg_die() {
1705 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
1706 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
1707 echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2 2609 echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2
1708 echo "and of course, the output of emerge --info" >&2 2610 echo "and of course, the output of emerge --info =${P}" >&2
1709} 2611}
1710 2612
1711# ------------------------------------------------------------------------------ 2613
1712# @section-end internal 2614# TODO document
1713# ------------------------------------------------------------------------------ 2615# List jars in the source directory, ${S}
2616java-pkg_jar-list() {
2617 if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
2618 einfo "Linked Jars"
2619 find "${S}" -type l -name '*.jar' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2620 einfo "Jars"
2621 find "${S}" -type f -name '*.jar' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2622 einfo "Classes"
2623 find "${S}" -type f -name '*.class' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2624 fi
2625}
2626
2627# @FUNCTION: java-pkg_verify-classes
2628# @INTERNAL
2629# @DESCRIPTION:
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
2635java-pkg_verify-classes() {
2636 #$(find ${D} -type f -name '*.jar' -o -name '*.class')
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}"
2656 result=$?
2657 else
2658 ebegin "Verifying java class versions (target: ${target})"
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 # remove the version specification, which may include globbing (* and [123])
2691 local stripped_pkg=$(echo "${target_pkg}" | sed \
2692 's/-\([0-9*]*\(\[[0-9]*\]\)*\)*\(\.\([0-9*]*\(\[[0-9]*\]\)*\)*\)*$//')
2693
2694 debug-print "Matching against: ${stripped_pkg}"
2695
2696 if [[ ${limit_to} != runtime && ! ( "${DEPEND}" =~ "$stripped_pkg" ) ]]; then
2697 dev_error="The ebuild is attempting to use ${target_pkg} that is not"
2698 dev_error="${dev_error} declared in DEPEND."
2699 if is-java-strict; then
2700 eerror "${dev_error}"
2701 die "${dev_error}"
2702 elif [[ ${BASH_SUBSHELL} = 0 ]]; then
2703 eerror "${dev_error}"
2704 elog "Because you have this package installed the package will"
2705 elog "build without problems, but please report this to"
2706 elog "http://bugs.gentoo.org"
2707 fi
2708 fi
2709
2710 if [[ ${limit_to} != build ]]; then
2711 if [[ ! ( ${RDEPEND} =~ "${stripped_pkg}" ) ]]; then
2712 if [[ ! ( ${PDEPEND} =~ "${stripped_pkg}" ) ]]; then
2713 dev_error="The ebuild is attempting to use ${target_pkg},"
2714 dev_error="${dev_error} without specifying --build-only, that is not declared in RDEPEND"
2715 dev_error="${dev_error} or PDEPEND."
2716 if is-java-strict; then
2717 eerror "${dev_error}"
2718 die "${dev_error}"
2719 elif [[ ${BASH_SUBSHELL} = 0 ]]; then
2720 eerror "${dev_error}"
2721 elog "The package will build without problems, but may fail to run"
2722 elog "if you don't have ${target_pkg} installed, so please report"
2723 elog "this to http://bugs.gentoo.org"
2724 fi
2725 fi
2726 fi
2727 fi
2728}
1714 2729
1715java-pkg_check-phase() { 2730java-pkg_check-phase() {
1716 local phase=${1} 2731 local phase=${1}
1717 local funcname=${2} 2732 local funcname=${FUNCNAME[1]}
1718 # TODO add check for java-stricter
1719 if [[ ${EBUILD_PHASE} != ${phase} ]]; then 2733 if [[ ${EBUILD_PHASE} != ${phase} ]]; then
1720 java-pkg_announce-qa-violation \
1721 "${funcname} used outside of src_${phase}" 2734 local msg="${funcname} used outside of src_${phase}"
2735 java-pkg_announce-qa-violation "${msg}"
1722 fi 2736 fi
1723} 2737}
1724 2738
1725java-pkg_check-versioned-jar() { 2739java-pkg_check-versioned-jar() {
1726 local jar=${1} 2740 local jar=${1}
1729 java-pkg_announce-qa-violation "installing versioned jar '${jar}'" 2743 java-pkg_announce-qa-violation "installing versioned jar '${jar}'"
1730 fi 2744 fi
1731} 2745}
1732 2746
1733java-pkg_check-jikes() { 2747java-pkg_check-jikes() {
1734 if hasq jikes ${IUSE}; then 2748 if has jikes ${IUSE}; then
1735 java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE" 2749 java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE"
1736 fi 2750 fi
1737} 2751}
1738 2752
1739java-pkg_announce-qa-violation() { 2753java-pkg_announce-qa-violation() {
1740 if hasq java-strict ${FEATURES}; then 2754 local nodie
2755 if [[ ${1} == "--nodie" ]]; then
2756 nodie="true"
2757 shift
2758 fi
1741 echo "Java QA Notice: $@" >&2 2759 echo "Java QA Notice: $@" >&2
1742 increment-qa-violations 2760 increment-qa-violations
1743 fi 2761 [[ -z "${nodie}" ]] && is-java-strict && die "${@}"
1744} 2762}
1745 2763
1746increment-qa-violations() { 2764increment-qa-violations() {
1747 let "JAVA_PKG_QA_VIOLATIONS+=1" 2765 let "JAVA_PKG_QA_VIOLATIONS+=1"
1748 export JAVA_PKG_QA_VIOLATIONS 2766 export JAVA_PKG_QA_VIOLATIONS
1749} 2767}
1750 2768
1751# ------------------------------------------------------------------------------ 2769is-java-strict() {
1752# @eclass-end 2770 [[ -n ${JAVA_PKG_STRICT} ]]
1753# ------------------------------------------------------------------------------ 2771 return $?
2772}

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

  ViewVC Help
Powered by ViewVC 1.1.20