/[gentoo-x86]/eclass/java-utils-2.eclass
Gentoo

Diff of /eclass/java-utils-2.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

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

  ViewVC Help
Powered by ViewVC 1.1.20