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

Legend:
Removed from v.1.22  
changed lines
  Added in v.1.159

  ViewVC Help
Powered by ViewVC 1.1.20