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

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

  ViewVC Help
Powered by ViewVC 1.1.20