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

Legend:
Removed from v.1.33  
changed lines
  Added in v.1.166

  ViewVC Help
Powered by ViewVC 1.1.20