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

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

  ViewVC Help
Powered by ViewVC 1.1.20