/[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.10 Revision 1.56
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# $Header: /var/cvsroot/gentoo-x86/eclass/java-utils-2.eclass,v 1.56 2007/01/30 14:12:34 caster Exp $
9 10
10 11
11# ----------------------------------------------------------------------------- 12# -----------------------------------------------------------------------------
12# @eclass-begin 13# @eclass-begin
13# @eclass-shortdesc Java Utility eclass 14# @eclass-shortdesc Java Utility eclass
14# @eclass-maintainer java@gentoo.org 15# @eclass-maintainer java@gentoo.org
15# 16#
16# This eclass provides functionality which is used by 17# This eclass provides functionality which is used by
17# java-pkg.eclass and java-pkg-opt.eclass as well as from ebuilds. 18# java-pkg.eclass and java-pkg-opt.eclass as well as from ebuilds.
18# 19#
19# @warning 20# @warning
20# You probably don't want to inherit this directly from an ebuild. Instead, 21# 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 22# 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. 23# Java packages, or java-pkg-opt for packages that have optional Java support.
23# 24#
24# ----------------------------------------------------------------------------- 25# -----------------------------------------------------------------------------
25 26
26inherit eutils versionator multilib 27inherit eutils versionator multilib
28
29IUSE="elibc_FreeBSD"
27 30
28# ----------------------------------------------------------------------------- 31# -----------------------------------------------------------------------------
29# @section-begin variables 32# @section-begin variables
30# @section-title Variables 33# @section-title Variables
31# 34#
33# ----------------------------------------------------------------------------- 36# -----------------------------------------------------------------------------
34 37
35# Make sure we use java-config-2 38# Make sure we use java-config-2
36export WANT_JAVA_CONFIG="2" 39export WANT_JAVA_CONFIG="2"
37 40
38# TODO document 41# -----------------------------------------------------------------------------
42# @variable-external WANT_ANT_TASKS
43# @variable-default ""
44#
45# An $IFS separated list of ant tasks.
46# Ebuild can specify this variable before inheriting java-ant-2 eclass to
47# determine ANT_TASKS it needs. They will be automatically translated to
48# DEPEND variable and ANT_TASKS variable. JAVA_PKG_FORCE_ANT_TASKS can override
49# ANT_TASKS set by WANT_ANT_TASKS, but not the DEPEND due to caching.
50# Ebuilds that need to depend conditionally on certain tasks and specify them
51# differently for different eant calls can't use this simplified approach.
52# You also cannot specify version or anything else than ant-*.
53#
54# @example WANT_ANT_TASKS="ant-junit ant-trax"
55#
56# @seealso JAVA_PKG_FORCE_ANT_TASKS
57# -----------------------------------------------------------------------------
58#WANT_ANT_TASKS
59
60# @variable-internal JAVA_PKG_PORTAGE_DEP
61#
62# The version of portage we need to function properly. At this moment it's
63# portage with phase hooks support.
64# -----------------------------------------------------------------------------
39JAVA_PKG_PORTAGE_DEP=">=sys-apps/portage-2.1_pre1" 65JAVA_PKG_PORTAGE_DEP=">=sys-apps/portage-2.1_pre1"
40 66
41# ----------------------------------------------------------------------------- 67# -----------------------------------------------------------------------------
42# @variable-internal JAVA_PKG_E_DEPEND 68# @variable-internal JAVA_PKG_E_DEPEND
43# 69#
44# This is a convience variable to be used from the other java eclasses. This is 70# This is a convience variable to be used from the other java eclasses. This is
45# the version of java-config we want to use. We also need a recent version 71# the version of java-config we want to use. We also need a recent version
46# portage, that includes phase hooks. 72# portage, that includes phase hooks.
47# ----------------------------------------------------------------------------- 73# -----------------------------------------------------------------------------
48JAVA_PKG_E_DEPEND=">=dev-java/java-config-2.0.19-r1 ${JAVA_PKG_PORTAGE_DEP}" 74JAVA_PKG_E_DEPEND=">=dev-java/java-config-2.0.19-r1 ${JAVA_PKG_PORTAGE_DEP}"
49 75
50# ----------------------------------------------------------------------------- 76# -----------------------------------------------------------------------------
100# ----------------------------------------------------------------------------- 126# -----------------------------------------------------------------------------
101 127
102# ----------------------------------------------------------------------------- 128# -----------------------------------------------------------------------------
103# @variable-internal JAVA_PKG_COMPILER_DIR 129# @variable-internal JAVA_PKG_COMPILER_DIR
104# @default /usr/share/java-config-2/compiler 130# @default /usr/share/java-config-2/compiler
105# 131#
106# Directory where compiler settings are saved, without trailing slash. 132# Directory where compiler settings are saved, without trailing slash.
107# Probably shouldn't touch this variable. 133# Probably shouldn't touch this variable.
108# ----------------------------------------------------------------------------- 134# -----------------------------------------------------------------------------
109JAVA_PKG_COMPILER_DIR=${JAVA_PKG_COMPILER_DIR:="/usr/share/java-config-2/compiler"} 135JAVA_PKG_COMPILER_DIR=${JAVA_PKG_COMPILER_DIR:="/usr/share/java-config-2/compiler"}
110 136
120 146
121# ----------------------------------------------------------------------------- 147# -----------------------------------------------------------------------------
122# @variable-external JAVA_PKG_FORCE_COMPILER 148# @variable-external JAVA_PKG_FORCE_COMPILER
123# 149#
124# Explicitly set a list of compilers to use. This is normally read from 150# Explicitly set a list of compilers to use. This is normally read from
125# JAVA_PKG_COMPILERS_CONF. 151# JAVA_PKG_COMPILERS_CONF.
126# 152#
127# @note This should only be used internally or for testing. 153# @note This should only be used internally or for testing.
128# @example Use jikes and javac, in that order 154# @example Use jikes and javac, in that order
129# JAVA_PKG_FORCE_COMPILER="jikes javac" 155# JAVA_PKG_FORCE_COMPILER="jikes javac"
130# ----------------------------------------------------------------------------- 156# -----------------------------------------------------------------------------
131 157
158# -----------------------------------------------------------------------------
159# @variable-external JAVA_PKG_FORCE_ANT_TASKS
160#
161# An $IFS separated list of ant tasks. Can be set in environment before calling
162# emerge/ebuild to override variables set in ebuild, mainly for testing before
163# putting the resulting (WANT_)ANT_TASKS into ebuild. Affects only ANT_TASKS in
164# eant() call, not the dependencies specified in WANT_ANT_TASKS.
165#
166# @example JAVA_PKG_FORCE_ANT_TASKS="ant-junit ant-trax" \
167# ebuild foo.ebuild compile
168#
169# @seealso WANT_ANT_TASKS
170# -----------------------------------------------------------------------------
171
132# TODO document me 172# TODO document me
133JAVA_PKG_QA_VIOLATIONS=0 173JAVA_PKG_QA_VIOLATIONS=0
134 174
135# ----------------------------------------------------------------------------- 175# -----------------------------------------------------------------------------
136# @section-end variables 176# @section-end variables
150# @ebuild-function java-pkg_dojar 190# @ebuild-function java-pkg_dojar
151# 191#
152# Installs any number of jars. 192# Installs any number of jars.
153# Jar's will be installed into /usr/share/${PN}(-${SLOT})/lib/ by default. 193# Jar's will be installed into /usr/share/${PN}(-${SLOT})/lib/ by default.
154# You can use java-pkg_jarinto to change this path. 194# You can use java-pkg_jarinto to change this path.
155# You should never install a jar with a package version in the filename. 195# You should never install a jar with a package version in the filename.
156# Instead, use java-pkg_newjar defined below. 196# Instead, use java-pkg_newjar defined below.
157# 197#
158# @example 198# @example
159# java-pkg_dojar dist/${PN}.jar dist/${PN}-core.jar 199# java-pkg_dojar dist/${PN}.jar dist/${PN}-core.jar
160# 200#
171 # Create JARDEST if it doesn't exist 211 # Create JARDEST if it doesn't exist
172 dodir ${JAVA_PKG_JARDEST} 212 dodir ${JAVA_PKG_JARDEST}
173 213
174 local jar 214 local jar
175 # for each jar 215 # for each jar
176 for jar in "$@"; do 216 for jar in "${@}"; do
177 local jar_basename=$(basename "${jar}") 217 local jar_basename=$(basename "${jar}")
178 218
179 java-pkg_check-versioned-jar ${jar_basename} 219 java-pkg_check-versioned-jar ${jar_basename}
180 220
181 # check if it exists 221 # check if it exists
182 if [[ -e "${jar}" ]] ; then 222 if [[ -e "${jar}" ]] ; then
223 # Don't overwrite if jar has already been installed with the same
224 # name
225 local dest="${D}${JAVA_PKG_JARDEST}/${jar_basename}"
226 if [[ -e "${dest}" ]]; then
227 ewarn "Overwriting ${dest}"
228 fi
229
183 # install it into JARDEST if it's a non-symlink 230 # install it into JARDEST if it's a non-symlink
184 if [[ ! -L "${jar}" ]] ; then 231 if [[ ! -L "${jar}" ]] ; then
232 #but first check class version when in strict mode.
233 is-java-strict && java-pkg_verify-classes "${jar}"
234
185 INSDESTTREE="${JAVA_PKG_JARDEST}" \ 235 INSDESTTREE="${JAVA_PKG_JARDEST}" \
186 doins "${jar}" || die "failed to install ${jar}" 236 doins "${jar}" || die "failed to install ${jar}"
187 java-pkg_append_ JAVA_PKG_CLASSPATH "${JAVA_PKG_JARDEST}/${jar_basename}" 237 java-pkg_append_ JAVA_PKG_CLASSPATH "${JAVA_PKG_JARDEST}/${jar_basename}"
188 debug-print "installed ${jar} to ${D}${JAVA_PKG_JARDEST}" 238 debug-print "installed ${jar} to ${D}${JAVA_PKG_JARDEST}"
189 # make a symlink to the original jar if it's symlink 239 # make a symlink to the original jar if it's symlink
200 250
201 java-pkg_do_write_ 251 java-pkg_do_write_
202} 252}
203 253
204 254
255# ------------------------------------------------------------------------------
256# @internal-function depend-java-query
257#
258# Wrapper for the depend-java-query binary to enable passing USE in env.
259# Using env variables keeps this eclass working with java-config versions that
260# do not handle use flags.
261# ------------------------------------------------------------------------------
262
263depend-java-query() {
264 USE="${USE}" $(which depend-java-query) "${@}"
265}
205 266
206# ------------------------------------------------------------------------------ 267# ------------------------------------------------------------------------------
207# @ebuild-function java-pkg_regjar 268# @ebuild-function java-pkg_regjar
208# 269#
209# Records an already installed jar in the package.env 270# Records an already installed jar in the package.env
222# will not work, because: 283# will not work, because:
223# * the `for jar in "$@"` can't expand the path to jar file names, as they 284# * the `for jar in "$@"` can't expand the path to jar file names, as they
224# don't exist yet 285# don't exist yet
225# * all `if ...` inside for will fail - the file '/opt/my-java/lib/*.jar' 286# * all `if ...` inside for will fail - the file '/opt/my-java/lib/*.jar'
226# doesn't exist 287# doesn't exist
227# 288#
228# you have to use it as: 289# you have to use it as:
229# 290#
230# java-pkg_regjar ${D}/opt/my-java/lib/*.jar 291# java-pkg_regjar ${D}/opt/my-java/lib/*.jar
231# 292#
232# @param $@ - jars to record 293# @param $@ - jars to record
240 [[ ${#} -lt 1 ]] && die "at least one argument needed" 301 [[ ${#} -lt 1 ]] && die "at least one argument needed"
241 302
242 java-pkg_init_paths_ 303 java-pkg_init_paths_
243 304
244 local jar jar_dir jar_file 305 local jar jar_dir jar_file
245 for jar in "$@"; do 306 for jar in "${@}"; do
246 # TODO use java-pkg_check-versioned-jar 307 # TODO use java-pkg_check-versioned-jar
247 if [[ -e "${jar}" ]]; then 308 if [[ -e "${jar}" || -e "${D}${jar}" ]]; then
309 [[ -d "${jar}" || -d "${D}${jar}" ]] \
310 && die "Called ${FUNCNAME} on a directory $*"
311
312 #check that class version correct when in strict mode
313 is-java-strict && java-pkg_verify-classes "${jar}"
314
248 # nelchael: we should strip ${D} in this case too, here's why: 315 # nelchael: we should strip ${D} in this case too, here's why:
249 # imagine such call: 316 # imagine such call:
250 # java-pkg_regjar ${D}/opt/java/*.jar 317 # java-pkg_regjar ${D}/opt/java/*.jar
251 # such call will fall into this case (-e ${jar}) and will 318 # such call will fall into this case (-e ${jar}) and will
252 # record paths with ${D} in package.env 319 # record paths with ${D} in package.env
253 java-pkg_append_ JAVA_PKG_CLASSPATH "${jar#${D}}" 320 java-pkg_append_ JAVA_PKG_CLASSPATH "${jar#${D}}"
254 elif [[ -e "${D}${jar}" ]]; then
255 java-pkg_append_ JAVA_PKG_CLASSPATH "${jar#${D}}"
256 else 321 else
257 die "${jar} does not exist" 322 die "${jar} does not exist"
258 fi 323 fi
259 done 324 done
260 325
261 java-pkg_do_write_ 326 java-pkg_do_write_
262} 327}
263
264 328
265# ------------------------------------------------------------------------------ 329# ------------------------------------------------------------------------------
266# @ebuild-function java-pkg_newjar 330# @ebuild-function java-pkg_newjar
267# 331#
268# Installs a jar with a new name 332# Installs a jar with a new name
279 local original_jar="${1}" 343 local original_jar="${1}"
280 local new_jar="${2:-${PN}.jar}" 344 local new_jar="${2:-${PN}.jar}"
281 local new_jar_dest="${T}/${new_jar}" 345 local new_jar_dest="${T}/${new_jar}"
282 346
283 [[ -z ${original_jar} ]] && die "Must specify a jar to install" 347 [[ -z ${original_jar} ]] && die "Must specify a jar to install"
284 [[ ! -f ${original_jar} ]] && die "${original_jar} does not exist!" 348 [[ ! -f ${original_jar} ]] \
349 && die "${original_jar} does not exist or is not a file!"
285 350
286 rm -f "${new_jar_dest}" || die "Failed to remove ${new_jar_dest}" 351 rm -f "${new_jar_dest}" || die "Failed to remove ${new_jar_dest}"
287 cp "${original_jar}" "${new_jar_dest}" \ 352 cp "${original_jar}" "${new_jar_dest}" \
288 || die "Failed to copy ${original_jar} to ${new_jar_dest}" 353 || die "Failed to copy ${original_jar} to ${new_jar_dest}"
289 java-pkg_dojar "${new_jar_dest}" 354 java-pkg_dojar "${new_jar_dest}"
290} 355}
291 356
292
293# ------------------------------------------------------------------------------ 357# ------------------------------------------------------------------------------
294# @ebuild-function java-pkg_addcp 358# @ebuild-function java-pkg_addcp
295# 359#
296# Add something to the package's classpath. For jars, you should use dojar, 360# Add something to the package's classpath. For jars, you should use dojar,
297# newjar, or regjar. This is typically used to add directories to the classpath. 361# newjar, or regjar. This is typically used to add directories to the classpath.
302java-pkg_addcp() { 366java-pkg_addcp() {
303 java-pkg_append_ JAVA_PKG_CLASSPATH "${@}" 367 java-pkg_append_ JAVA_PKG_CLASSPATH "${@}"
304 java-pkg_do_write_ 368 java-pkg_do_write_
305} 369}
306 370
307
308# ------------------------------------------------------------------------------ 371# ------------------------------------------------------------------------------
309# @ebuild-function java-pkg_doso 372# @ebuild-function java-pkg_doso
310# 373#
311# Installs any number of JNI libraries 374# Installs any number of JNI libraries
312# They will be installed into /usr/lib by default, but java-pkg_sointo 375# They will be installed into /usr/lib by default, but java-pkg_sointo
313# can be used change this path 376# can be used change this path
314# 377#
315# Example: 378# Example:
370 java-pkg_check-phase install 433 java-pkg_check-phase install
371 434
372 [[ ${#} -lt 1 ]] && "at least one argument needed" 435 [[ ${#} -lt 1 ]] && "at least one argument needed"
373 436
374 java-pkg_init_paths_ 437 java-pkg_init_paths_
375 438
376 local lib target_dir 439 local lib target_dir
377 for lib in "$@" ; do 440 for lib in "$@" ; do
378 # Check the absolute path of the lib 441 # Check the absolute path of the lib
379 if [[ -e "${lib}" ]] ; then 442 if [[ -e "${lib}" ]] ; then
380 target_dir="$(java-pkg_expand_dir_ ${lib})" 443 target_dir="$(java-pkg_expand_dir_ ${lib})"
428# ------------------------------------------------------------------------------ 491# ------------------------------------------------------------------------------
429java-pkg_dohtml() { 492java-pkg_dohtml() {
430 debug-print-function ${FUNCNAME} $* 493 debug-print-function ${FUNCNAME} $*
431 494
432 [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}" 495 [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}"
433 # TODO-nichoj find out what exactly -f package-list does 496
497 # from /usr/lib/portage/bin/dohtml -h
498 # -f Set list of allowed extensionless file names.
434 dohtml -f package-list "$@" 499 dohtml -f package-list "$@"
500
435 # this probably shouldn't be here but it provides 501 # this probably shouldn't be here but it provides
436 # a reasonable way to catch # docs for all of the 502 # a reasonable way to catch # docs for all of the
437 # old ebuilds. 503 # old ebuilds.
438 java-pkg_recordjavadoc 504 java-pkg_recordjavadoc
439} 505}
440 506
441# TODO document 507# ------------------------------------------------------------------------------
508# @ebuild-function java-pkg_dojavadoc
509#
510# Installs javadoc documentation. This should be controlled by the doc use flag.
511#
512# @param $1: - The javadoc root directory.
513#
514# @example:
515# java-pkg_dojavadoc docs/api
516#
517# ------------------------------------------------------------------------------
442java-pkg_dojavadoc() { 518java-pkg_dojavadoc() {
443 local dir="$1" 519 local dir="$1"
444 520
445 java-pkg_check-phase install 521 java-pkg_check-phase install
446 522
458} 534}
459 535
460# ------------------------------------------------------------------------------ 536# ------------------------------------------------------------------------------
461# @ebuild-function java-pkg_dosrc 537# @ebuild-function java-pkg_dosrc
462# 538#
463# Installs a zip containing the source for a package, so it can used in 539# Installs a zip containing the source for a package, so it can used in
464# from IDEs like eclipse and netbeans. 540# from IDEs like eclipse and netbeans.
465# 541#
466# Ebuild needs to DEPEND on app-arch/zip to use this. 542# Ebuild needs to DEPEND on app-arch/zip to use this.
467# 543#
468# It also should be controlled by USE=source. 544# It also should be controlled by USE=source.
469# 545#
470# @example: 546# @example:
471# java-pkg_dosrc src/* 547# java-pkg_dosrc src/*
472# 548#
473# ------------------------------------------------------------------------------ 549# ------------------------------------------------------------------------------
474# TODO change so it the arguments it takes are the base directories containing 550# TODO change so it the arguments it takes are the base directories containing
475# source -nichoj 551# source -nichoj
476# TODO should we be able to handle multiple calls to dosrc? -nichoj 552# TODO should we be able to handle multiple calls to dosrc? -nichoj
477# TODO maybe we can take an existing zip/jar? -nichoj 553# TODO maybe we can take an existing zip/jar? -nichoj
478# FIXME apparently this fails if you give it an empty directories 554# FIXME apparently this fails if you give it an empty directories
479java-pkg_dosrc() { 555java-pkg_dosrc() {
480 debug-print-function ${FUNCNAME} $* 556 debug-print-function ${FUNCNAME} $*
481 557
482 [ ${#} -lt 1 ] && die "At least one argument needed" 558 [ ${#} -lt 1 ] && die "At least one argument needed"
483 if ! hasq source ${IUSE}; then 559 if ! hasq source ${IUSE}; then
484 echo "Java QA Notice: ${FUNCNAME} called without source in IUSE" 560 echo "Java QA Notice: ${FUNCNAME} called without source in IUSE"
485 fi 561 fi
486 562
487 java-pkg_check-phase install 563 java-pkg_check-phase install
488 564
489 [[ ${#} -lt 1 ]] && die "At least one argument needed" 565 [[ ${#} -lt 1 ]] && die "At least one argument needed"
490 566
491 java-pkg_init_paths_ 567 java-pkg_init_paths_
492 568
493 local zip_name="${PN}-src.zip" 569 local zip_name="${PN}-src.zip"
494 local zip_path="${T}/${zip_name}" 570 local zip_path="${T}/${zip_name}"
495 local dir 571 local dir
496 for dir in ${@}; do 572 for dir in "${@}"; do
497 local dir_parent=$(dirname "${dir}") 573 local dir_parent=$(dirname "${dir}")
498 local dir_name=$(basename "${dir}") 574 local dir_name=$(basename "${dir}")
499 pushd ${dir_parent} > /dev/null || die "problem entering ${dir_parent}" 575 pushd ${dir_parent} > /dev/null || die "problem entering ${dir_parent}"
500 zip -q -r ${zip_path} ${dir_name} -i '*.java' 576 zip -q -r ${zip_path} ${dir_name} -i '*.java'
501 local result=$? 577 local result=$?
518# @ebuild-function java-pkg_dolauncher 594# @ebuild-function java-pkg_dolauncher
519# 595#
520# Make a wrapper script to lauch/start this package 596# Make a wrapper script to lauch/start this package
521# If necessary, the wrapper will switch to the appropriate VM. 597# If necessary, the wrapper will switch to the appropriate VM.
522# 598#
599# Can be called without parameters if the package installs only one jar
600# that has the Main-class attribute set. The wrapper will be named ${PN}.
601#
523# @param $1 - filename of launcher to create 602# @param $1 - filename of launcher to create
524# @param $2 - options, as follows: 603# @param $2 - options, as follows:
525# --main the.main.class.too.start 604# --main the.main.class.too.start
526# --jar /the/jar/too/launch.jar 605# --jar /the/jar/too/launch.jar or just <name>.jar
527# --java_args 'Extra arguments to pass too jave' 606# --java_args 'Extra arguments to pass to java'
528# --pkg_args 'extra arguments too pass too the package' 607# --pkg_args 'Extra arguments to pass to the package'
529# --pwd 608# --pwd Directory the launcher changes to before executing java
530# -into 609# -into Directory to install the launcher to, instead of /usr/bin
531# -pre 610# -pre Prepend contents of this file to the launcher
532# ------------------------------------------------------------------------------ 611# ------------------------------------------------------------------------------
533java-pkg_dolauncher() { 612java-pkg_dolauncher() {
534 debug-print-function ${FUNCNAME} $* 613 debug-print-function ${FUNCNAME} $*
535 614
536 java-pkg_check-phase install 615 java-pkg_check-phase install
537
538 [[ ${#} -lt 1 ]] && die "Need at least one argument"
539
540 java-pkg_init_paths_ 616 java-pkg_init_paths_
541 617
618 if [[ ${#} = 0 ]]; then
619 local name="${PN}"
620 else
542 local name="${1}" 621 local name="${1}"
622 shift
623 fi
624
543 # TODO rename to launcher 625 # TODO rename to launcher
544 local target="${T}/${name}" 626 local target="${T}/${name}"
627 local var_tmp="${T}/launcher_variables_tmp"
545 local target_dir pre 628 local target_dir pre
546 shift
547 629
548 echo "#!/bin/bash" > "${target}" 630 # Process the other the rest of the arguments
549 while [[ -n "${1}" && -n "${2}" ]]; do 631 while [[ -n "${1}" && -n "${2}" ]]; do
550 local var=${1} value=${2} 632 local var="${1}" value="${2}"
551 if [[ "${var:0:2}" == "--" ]]; then 633 if [[ "${var:0:2}" == "--" ]]; then
634 local var=${var:2}
552 echo "gjl_${var:2}=\"${value}\"" >> "${target}" 635 echo "gjl_${var}=\"${value}\"" >> "${var_tmp}"
636 local gjl_${var}="${value}"
553 elif [[ "${var}" == "-into" ]]; then 637 elif [[ "${var}" == "-into" ]]; then
554 target_dir="${value}" 638 target_dir="${value}"
555 elif [[ "${var}" == "-pre" ]]; then 639 elif [[ "${var}" == "-pre" ]]; then
556 pre="${value}" 640 pre="${value}"
557 fi 641 fi
558 shift 2 642 shift 2
559 done 643 done
644
645 # Test if no --jar and --main arguments were given and
646 # in that case check if the package only installs one jar
647 # and use that jar.
648 if [[ -z "${gjl_jar}" && -z "${gjl_main}" ]]; then
649 local cp="${JAVA_PKG_CLASSPATH}"
650 if [[ "${cp/:}" = "${cp}" && "${cp%.jar}" != "${cp}" ]]; then
651 echo "gjl_jar=\"${JAVA_PKG_CLASSPATH}\"" >> "${var_tmp}"
652 else
653 local msg="Not enough information to create a launcher given."
654 msg="${msg} Please give --jar or --main argument to ${FUNCNAME}."
655 die "${msg}"
656 fi
657 fi
658
659 # Write the actual script
660 echo "#!/bin/bash" > "${target}"
661 if [[ -n "${pre}" ]]; then
662 if [[ -f "${pre}" ]]; then
663 cat "${pre}" >> "${target}"
664 else
665 die "-pre specified file '${pre}' does not exist"
666 fi
667 fi
560 echo "gjl_package=${JAVA_PKG_NAME}" >> "${target}" 668 echo "gjl_package=${JAVA_PKG_NAME}" >> "${target}"
561 [[ -n "${pre}" ]] && [[ -f "${pre}" ]] && cat "${pre}" >> "${target}" 669 cat "${var_tmp}" >> "${target}"
670 rm -f "${var_tmp}"
562 echo "source /usr/share/java-config-2/launcher/launcher.bash" >> "${target}" 671 echo "source /usr/share/java-config-2/launcher/launcher.bash" >> "${target}"
563 672
564 if [[ -n "${into}" ]]; then 673 if [[ -n "${target_dir}" ]]; then
565 DESTTREE="${target_dir}" dobin "${target}" 674 DESTTREE="${target_dir}" dobin "${target}"
566 local ret=$? 675 local ret=$?
567 return ${ret} 676 return ${ret}
568 else 677 else
569 dobin "${target}" 678 dobin "${target}"
597 echo "dowar: warning, skipping directory ${war}" 706 echo "dowar: warning, skipping directory ${war}"
598 continue 707 continue
599 else 708 else
600 warpath="${war}" 709 warpath="${war}"
601 fi 710 fi
602 711
603 # Install those files like you mean it 712 # Install those files like you mean it
604 INSOPTIONS="-m 0644" \ 713 INSOPTIONS="-m 0644" \
605 INSDESTTREE=${JAVA_PKG_WARDEST} \ 714 INSDESTTREE=${JAVA_PKG_WARDEST} \
606 doins ${warpath} 715 doins ${warpath}
607 done 716 done
642# @ebuild-function java-pkg_jar-from 751# @ebuild-function java-pkg_jar-from
643# 752#
644# Makes a symlink to a jar from a certain package 753# Makes a symlink to a jar from a certain package
645# A lot of java packages include dependencies in a lib/ directory 754# A lot of java packages include dependencies in a lib/ directory
646# You can use this function to replace these bundled dependencies. 755# You can use this function to replace these bundled dependencies.
756# The dependency is recorded into package.env DEPEND line, unless "--build-only"
757# is passed as the very first argument, for jars that have to be present only
758# at build time and are not needed on runtime (junit testing etc).
647# 759#
648# Example: get all jars from xerces slot 2 760# Example: get all jars from xerces slot 2
649# java-pkg_jar-from xerces-2 761# java-pkg_jar-from xerces-2
650# Example: get a specific jar from xerces slot 2 762# Example: get a specific jar from xerces slot 2
651# java-pkg_jar-from xerces-2 xml-apis.jar 763# java-pkg_jar-from xerces-2 xml-apis.jar
652# Example get a specific jar from xerces slot 2, and name it diffrently 764# Example: get a specific jar from xerces slot 2, and name it diffrently
653# java-pkg_jar-from xerces-2 xml-apis.jar xml.jar 765# java-pkg_jar-from xerces-2 xml-apis.jar xml.jar
766# Example: get junit.jar which is needed only for building
767# java-pkg_jar-from --build-only junit junit.jar
654# 768#
769# @param $opt
770# --build-only - makes the jar(s) not added into package.env DEPEND line.
771# (assumed automatically when called inside src_test)
772# --with-dependencies - get jars also from requested package's dependencies
773# transitively.
774# --into $dir - symlink jar(s) into $dir (must exist) instead of .
655# @param $1 - Package to get jars from. 775# @param $1 - Package to get jars from.
656# @param $2 - jar from package. If not specified, all jars will be used. 776# @param $2 - jar from package. If not specified, all jars will be used.
657# @param $3 - When a single jar is specified, destination filename of the 777# @param $3 - When a single jar is specified, destination filename of the
658# symlink. Defaults to the name of the jar. 778# symlink. Defaults to the name of the jar.
659# ------------------------------------------------------------------------------ 779# ------------------------------------------------------------------------------
660# TODO could probably be cleaned up a little 780# TODO could probably be cleaned up a little
661java-pkg_jar-from() { 781java-pkg_jar-from() {
662 debug-print-function ${FUNCNAME} $* 782 debug-print-function ${FUNCNAME} $*
663 783
664 local target_pkg="${1}" target_jar="${2}" destjar="${3}" 784 local build_only=""
785 local destdir="."
786 local deep=""
665 787
788 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="true"
789
790 while [[ "${1}" == --* ]]; do
791 if [[ "${1}" = "--build-only" ]]; then
792 build_only="true"
793 elif [[ "${1}" = "--with-dependencies" ]]; then
794 deep="--with-dependencies"
795 elif [[ "${1}" = "--into" ]]; then
796 destdir="${2}"
797 shift
798 else
799 die "java-pkg_jar-from called with unknown parameter: ${1}"
800 fi
801 shift
802 done
803
804 local target_pkg="${1}" target_jar="${2}" destjar="${3}"
805
666 [[ -z ${target_pkg} ]] && die "Must specify a package" 806 [[ -z ${target_pkg} ]] && die "Must specify a package"
667 807
668 # default destjar to the target jar 808 # default destjar to the target jar
669 [[ -z "${destjar}" ]] && destjar="${target_jar}" 809 [[ -z "${destjar}" ]] && destjar="${target_jar}"
670 810
811 local error_msg="There was a problem getting the classpath for ${target_pkg}."
812 local classpath
671 local classpath="$(java-config --classpath=${target_pkg})" 813 classpath="$(java-config ${deep} --classpath=${target_pkg})"
672 [[ $? != 0 ]] && die "There was a problem getting the classpath for ${target_pkg}" 814 [[ $? != 0 ]] && die ${error_msg}
673 815
816 pushd ${destdir} > /dev/null \
817 || die "failed to change directory to ${destdir}"
674 local jar 818 local jar
675 for jar in ${classpath//:/ }; do 819 for jar in ${classpath//:/ }; do
676 local jar_name=$(basename "${jar}") 820 local jar_name=$(basename "${jar}")
677 if [[ ! -f "${jar}" ]] ; then 821 if [[ ! -f "${jar}" ]] ; then
678 debug-print "${jar} from ${target_pkg} does not exist" 822 debug-print "${jar} from ${target_pkg} does not exist"
681 # If no specific target jar was indicated, link it 825 # If no specific target jar was indicated, link it
682 if [[ -z "${target_jar}" ]] ; then 826 if [[ -z "${target_jar}" ]] ; then
683 [[ -f "${target_jar}" ]] && rm "${target_jar}" 827 [[ -f "${target_jar}" ]] && rm "${target_jar}"
684 ln -snf "${jar}" \ 828 ln -snf "${jar}" \
685 || die "Failed to make symlink from ${jar} to ${jar_name}" 829 || die "Failed to make symlink from ${jar} to ${jar_name}"
686 java-pkg_record-jar_ "${target_pkg}" "${jar}" 830 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${target_pkg}" "${jar}"
687 # otherwise, if the current jar is the target jar, link it 831 # otherwise, if the current jar is the target jar, link it
688 elif [[ "${jar_name}" == "${target_jar}" ]] ; then 832 elif [[ "${jar_name}" == "${target_jar}" ]] ; then
689 [[ -f "${destjar}" ]] && rm "${destjar}" 833 [[ -f "${destjar}" ]] && rm "${destjar}"
690 ln -snf "${jar}" "${destjar}" \ 834 ln -snf "${jar}" "${destjar}" \
691 || die "Failed to make symlink from ${jar} to ${destjar}" 835 || die "Failed to make symlink from ${jar} to ${destjar}"
692 java-pkg_record-jar_ "${target_pkg}" "${jar}" 836 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${target_pkg}" "${jar}"
837 popd > /dev/null
693 return 0 838 return 0
694 fi 839 fi
695 done 840 done
841 popd > /dev/null
696 # if no target was specified, we're ok 842 # if no target was specified, we're ok
697 if [[ -z "${target_jar}" ]] ; then 843 if [[ -z "${target_jar}" ]] ; then
698 return 0 844 return 0
699 # otherwise, die bitterly 845 # otherwise, die bitterly
700 else 846 else
714# ------------------------------------------------------------------------------ 860# ------------------------------------------------------------------------------
715# @ebuild-function java-pkg_getjars 861# @ebuild-function java-pkg_getjars
716# 862#
717# Get the classpath provided by any number of packages 863# Get the classpath provided by any number of packages
718# Among other things, this can be passed to 'javac -classpath' or 'ant -lib'. 864# Among other things, this can be passed to 'javac -classpath' or 'ant -lib'.
865# The providing packages are recorded as dependencies into package.env DEPEND
866# line, unless "--build-only" is passed as the very first argument, for jars
867# that have to be present only at build time and are not needed on runtime
868# (junit testing etc).
719# 869#
720# Example: Get the classpath for xerces-2, 870# Example: Get the classpath for xerces-2 and xalan,
721# java-pkg_getjars xerces-2 xalan 871# java-pkg_getjars xerces-2,xalan
722# Example Return: 872# Example Return:
723# /usr/share/xerces-2/lib/xml-apis.jar:/usr/share/xerces-2/lib/xmlParserAPIs.jar:/usr/share/xalan/lib/xalan.jar 873# /usr/share/xerces-2/lib/xml-apis.jar:/usr/share/xerces-2/lib/xmlParserAPIs.jar:/usr/share/xalan/lib/xalan.jar
724# 874#
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.
725# @param $@ - list of packages to get jars from 880# @param $1 - list of packages to get jars from
881# (passed to java-config --classpath)
726# ------------------------------------------------------------------------------ 882# ------------------------------------------------------------------------------
727java-pkg_getjars() { 883java-pkg_getjars() {
728 debug-print-function ${FUNCNAME} $* 884 debug-print-function ${FUNCNAME} $*
729 885
730 [[ ${#} -lt 1 ]] && die "At least one argument needed" 886 local build_only=""
887 local deep=""
888
889 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="true"
731 890
732 # NOTE could probably just pass $@ to java-config --classpath. and return it 891 while [[ "${1}" == --* ]]; do
733 local classpath pkg 892 if [[ "${1}" = "--build-only" ]]; then
734 for pkg in ${@//,/ }; do 893 build_only="true"
735 #for pkg in $(echo "$@" | tr ',' ' '); do 894 elif [[ "${1}" = "--with-dependencies" ]]; then
736 jars="$(java-config --classpath=${pkg})" 895 deep="--with-dependencies"
737 debug-print "${pkg}:${jars}"
738 # TODO should we ensure jars exist?
739 if [[ -z "${classpath}" ]]; then
740 classpath="${jars}"
741 else 896 else
742 classpath="${classpath}:${jars}" 897 die "java-pkg_jar-from called with unknown parameter: ${1}"
743 fi 898 fi
744 java-pkg_record-jar_ "${pkg}" 899 shift
745 done 900 done
901
902 [[ ${#} -ne 1 ]] && die "${FUNCNAME} takes only one argument besides --*"
903
904 local classpath pkgs="${1}"
905 jars="$(java-config ${deep} --classpath=${pkgs})"
906 [[ -z "${jars}" ]] && die "java-config --classpath=${pkgs} failed"
907 debug-print "${pkgs}:${jars}"
908
909 if [[ -z "${classpath}" ]]; then
910 classpath="${jars}"
911 else
912 classpath="${classpath}:${jars}"
913 fi
914
915 # Only record jars that aren't build-only
916 if [[ -z "${build_only}" ]]; then
917 oldifs="${IFS}"
918 IFS=","
919 for pkg in ${pkgs}; do
920 java-pkg_record-jar_ "${pkg}"
921 done
922 IFS="${oldifs}"
923 fi
924
746 echo "${classpath}" 925 echo "${classpath}"
747} 926}
748 927
749# ------------------------------------------------------------------------------ 928# ------------------------------------------------------------------------------
750# @ebuild-function java-pkg_getjar 929# @ebuild-function java-pkg_getjar
751# 930#
752# Get the filename of a single jar from a package 931# Get the filename of a single jar from a package
932# The providing package is recorded as runtime dependency into package.env
933# DEPEND line, unless "--build-only" is passed as the very first argument, for
934# jars that have to be present only at build time and are not needed on runtime
935# (junit testing etc).
753# 936#
754# @example 937# @example
755# java-pkg_getjar xerces-2 xml-apis.jar 938# java-pkg_getjar xerces-2 xml-apis.jar
756# @example-return 939# @example-return
757# /usr/share/xerces-2/lib/xml-apis.jar 940# /usr/share/xerces-2/lib/xml-apis.jar
758# 941#
942# @param $opt
943# --build-only - makes the jar not added into package.env DEPEND line.
759# @param $1 - package to use 944# @param $1 - package to use
760# @param $2 - jar to get 945# @param $2 - jar to get
761# ------------------------------------------------------------------------------ 946# ------------------------------------------------------------------------------
762java-pkg_getjar() { 947java-pkg_getjar() {
763 debug-print-function ${FUNCNAME} $* 948 debug-print-function ${FUNCNAME} $*
949
950 local build_only=""
951
952 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="true"
953
954 while [[ "${1}" == --* ]]; do
955 if [[ "${1}" = "--build-only" ]]; then
956 build_only="true"
957 else
958 die "java-pkg_jar-from called with unknown parameter: ${1}"
959 fi
960 shift
961 done
962
963 [[ ${#} -ne 2 ]] && die "${FUNCNAME} takes only two arguments besides --*"
764 964
765 local pkg="${1}" target_jar="${2}" jar 965 local pkg="${1}" target_jar="${2}" jar
766 [[ -z ${pkg} ]] && die "Must specify package to get a jar from" 966 [[ -z ${pkg} ]] && die "Must specify package to get a jar from"
767 [[ -z ${target_jar} ]] && die "Must specify jar to get" 967 [[ -z ${target_jar} ]] && die "Must specify jar to get"
768 968
769 # TODO check that package is actually installed 969 local error_msg="Could not find classpath for ${pkg}. Are you sure its installed?"
970 local classpath
770 local classpath=$(java-config --classpath=${pkg}) 971 classpath=$(java-config --classpath=${pkg})
771 [[ $? != 0 ]] && die "There could not find classpath for ${pkg}. Are you sure its installed?" 972 [[ $? != 0 ]] && die ${error_msg}
973
772 for jar in ${classpath//:/ }; do 974 for jar in ${classpath//:/ }; do
773 if [[ ! -f "${jar}" ]] ; then 975 if [[ ! -f "${jar}" ]] ; then
774 die "Installation problems with jars in ${pkg} - is it installed?" 976 die "Installation problem with jar ${jar} in ${pkg} - is it installed?"
775 fi 977 fi
776 978
777 if [[ "$(basename ${jar})" == "${target_jar}" ]] ; then 979 if [[ "$(basename ${jar})" == "${target_jar}" ]] ; then
778 java-pkg_record-jar_ "${pkg}" "${jar}" 980 # Only record jars that aren't build-only
981 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${pkg}" "${jar}"
779 echo "${jar}" 982 echo "${jar}"
780 return 0 983 return 0
781 fi 984 fi
782 done 985 done
783 986
784 die "Could not find ${target_jar} in ${pkg}" 987 die "Could not find ${target_jar} in ${pkg}"
785 return 1 988 return 1
786} 989}
787 990
788# This function reads stdin, and based on that input, figures out how to 991# This function reads stdin, and based on that input, figures out how to
802# line="${line// /}" 1005# line="${line// /}"
803# 1006#
804# # format: path=jarinfo 1007# # format: path=jarinfo
805# local path=${line%%=*} 1008# local path=${line%%=*}
806# local jarinfo=${line##*=} 1009# local jarinfo=${line##*=}
807# 1010#
808# # format: jar@package 1011# # format: jar@package
809# local jar=${jarinfo%%@*}.jar 1012# local jar=${jarinfo%%@*}.jar
810# local package=${jarinfo##*@} 1013# local package=${jarinfo##*@}
811# if [[ -n ${replace_only} ]]; then 1014# if [[ -n ${replace_only} ]]; then
812# [[ ! -f $path ]] && die "No jar exists at ${path}" 1015# [[ ! -f $path ]] && die "No jar exists at ${path}"
825# @section-end query 1028# @section-end query
826# ------------------------------------------------------------------------------ 1029# ------------------------------------------------------------------------------
827 1030
828# ------------------------------------------------------------------------------ 1031# ------------------------------------------------------------------------------
829# @section-begin helper 1032# @section-begin helper
830# @section-summary Helper functions 1033# @section-summary Helper functions
831# 1034#
832# Various other functions to use from an ebuild 1035# Various other functions to use from an ebuild
833# ------------------------------------------------------------------------------ 1036# ------------------------------------------------------------------------------
834 1037
835# ------------------------------------------------------------------------------ 1038# ------------------------------------------------------------------------------
841# jdbc-stdext 1044# jdbc-stdext
842# jaf 1045# jaf
843# jdbc-rowset 1046# jdbc-rowset
844# jms 1047# jms
845# 1048#
846# @param $1 - Optionally indicate that the dependencies are controlled by 1049# @param $1 - Optionally indicate that the dependencies are controlled by
847# a use flag by specifying '--use' Requires $2. 1050# a use flag by specifying '--use' Requires $2.
848# @param $2 - USE flag which will enable the dependencies. 1051# @param $2 - USE flag which will enable the dependencies.
849# @param $@ - virtual packages to add depenedencies for 1052# @param $@ - virtual packages to add depenedencies for
850# ------------------------------------------------------------------------------ 1053# ------------------------------------------------------------------------------
851# TODO rewrite to parse a line based declaration file instead -- karltk 1054# TODO rewrite to parse a line based declaration file instead -- karltk
907# 1110#
908# export DEPEND="${DEPEND} ${depstr}" 1111# export DEPEND="${DEPEND} ${depstr}"
909# export RDEPEND="${RDEPEND} ${depstr}" 1112# export RDEPEND="${RDEPEND} ${depstr}"
910#} 1113#}
911 1114
1115# ------------------------------------------------------------------------------
1116# @ebuild-function java-pkg_find-normal-jars
1117#
1118# Find the files with suffix .jar file in the given directory or $WORKDIR
1119#
1120# @param $1 - The directory to search for jar files (default: ${WORKDIR})
1121# ------------------------------------------------------------------------------
1122java-pkg_find-normal-jars() {
1123 local dir=$1
1124 [[ "${dir}" ]] || dir="${WORKDIR}"
1125 local found
1126 for jar in $(find "${dir}" -name "*.jar" -type f); do
1127 echo "${jar}"
1128 found="true"
1129 done
1130 [[ "${found}" ]]
1131 return $?
1132}
1133
1134# ------------------------------------------------------------------------------
1135# @ebuild-function java-pkg_ensure-no-bundled-jars
1136#
1137# Try to locate bundled jar files in ${WORKDIR} and die if found.
912# This should be used after S has been populated with symlinks to jars 1138# This function should be called after WORKDIR has been populated with symlink
913# TODO document 1139# to system jar files or bundled jars removed.
1140# ------------------------------------------------------------------------------
914java-pkg_ensure-no-bundled-jars() { 1141java-pkg_ensure-no-bundled-jars() {
915 debug-print-function ${FUNCNAME} $* 1142 debug-print-function ${FUNCNAME} $*
916 pushd ${WORKDIR} >/dev/null 2>/dev/null
917 1143
918 local bundled_jars=$(find . -name "*.jar" -type f) 1144 local bundled_jars=$(java-pkg_find-normal-jars)
919 if [[ -n ${bundled_jars} ]]; then 1145 if [[ -n ${bundled_jars} ]]; then
920 echo "Bundled jars found:" 1146 echo "Bundled jars found:"
921 local jar 1147 local jar
922 for jar in ${bundled_jars}; do 1148 for jar in ${bundled_jars}; do
923 echo $(pwd)${jar/./} 1149 echo $(pwd)${jar/./}
924 done 1150 done
925 die "Bundled jars found!" 1151 die "Bundled jars found!"
926
927 fi 1152 fi
928 popd >/dev/null 2>/dev/null
929} 1153}
930 1154
931# ------------------------------------------------------------------------------ 1155# ------------------------------------------------------------------------------
932# @internal-function java-pkg_ensure-vm-version-sufficient 1156# @internal-function java-pkg_ensure-vm-version-sufficient
933# 1157#
945 fi 1169 fi
946} 1170}
947 1171
948# ------------------------------------------------------------------------------ 1172# ------------------------------------------------------------------------------
949# @internal-function java-pkg_is-vm-version-sufficient 1173# @internal-function java-pkg_is-vm-version-sufficient
950# 1174#
951# @return zero - VM is sufficient 1175# @return zero - VM is sufficient
952# @return non-zero - VM is not sufficient 1176# @return non-zero - VM is not sufficient
953# ------------------------------------------------------------------------------ 1177# ------------------------------------------------------------------------------
954java-pkg_is-vm-version-sufficient() { 1178java-pkg_is-vm-version-sufficient() {
955 debug-print-function ${FUNCNAME} $* 1179 debug-print-function ${FUNCNAME} $*
975 die "Active Java VM too old" 1199 die "Active Java VM too old"
976 fi 1200 fi
977} 1201}
978 1202
979# ------------------------------------------------------------------------------ 1203# ------------------------------------------------------------------------------
980# @internal-function java-pkg_is-vm-version-eq 1204# @internal-function java-pkg_is-vm-version-eq
981# 1205#
982# @param $@ - VM version to compare current VM to 1206# @param $@ - VM version to compare current VM to
983# @return zero - VM versions are equal 1207# @return zero - VM versions are equal
984# @return non-zero - VM version are not equal 1208# @return non-zero - VM version are not equal
985# ------------------------------------------------------------------------------ 1209# ------------------------------------------------------------------------------
986java-pkg_is-vm-version-eq() { 1210java-pkg_is-vm-version-eq() {
1016# 1240#
1017# @param $@ - VM version to compare current to 1241# @param $@ - VM version to compare current to
1018# ------------------------------------------------------------------------------ 1242# ------------------------------------------------------------------------------
1019java-pkg_ensure-vm-version-ge() { 1243java-pkg_ensure-vm-version-ge() {
1020 debug-print-function ${FUNCNAME} $* 1244 debug-print-function ${FUNCNAME} $*
1021 1245
1022 if ! java-pkg_is-vm-version-ge "$@" ; then 1246 if ! java-pkg_is-vm-version-ge "$@" ; then
1023 debug-print "vm is not suffient" 1247 debug-print "vm is not suffient"
1024 eerror "This package requires a Java VM version >= $@" 1248 eerror "This package requires a Java VM version >= $@"
1025 einfo "Please use java-config -S to set the correct one" 1249 einfo "Please use java-config -S to set the correct one"
1026 die "Active Java VM too old" 1250 die "Active Java VM too old"
1027 fi 1251 fi
1028} 1252}
1029 1253
1030# ------------------------------------------------------------------------------ 1254# ------------------------------------------------------------------------------
1031# @internal-function java-pkg_is-vm-version-ge 1255# @internal-function java-pkg_is-vm-version-ge
1032# 1256#
1033# @param $@ - VM version to compare current VM to 1257# @param $@ - VM version to compare current VM to
1034# @return zero - current VM version is greater than checked version 1258# @return zero - current VM version is greater than checked version
1035# @return non-zero - current VM version is not greater than checked version 1259# @return non-zero - current VM version is not greater than checked version
1036# ------------------------------------------------------------------------------ 1260# ------------------------------------------------------------------------------
1037java-pkg_is-vm-version-ge() { 1261java-pkg_is-vm-version-ge() {
1051 return 1 1275 return 1
1052 fi 1276 fi
1053 fi 1277 fi
1054} 1278}
1055 1279
1280java-pkg_set-current-vm() {
1281 export GENTOO_VM=${1}
1282}
1283
1284java-pkg_get-current-vm() {
1285 echo ${GENTOO_VM}
1286}
1287
1288java-pkg_current-vm-matches() {
1289 hasq $(java-pkg_get-current-vm) ${@}
1290 return $?
1291}
1292
1056# ------------------------------------------------------------------------------ 1293# ------------------------------------------------------------------------------
1057# @ebuild-function java-pkg_get-source 1294# @ebuild-function java-pkg_get-source
1058# 1295#
1059# Determines what source version should be used, for passing to -source. 1296# Determines what source version should be used, for passing to -source.
1060# Unless you want to break things you probably shouldn't set _WANT_SOURCE 1297# Unless you want to break things you probably shouldn't set _WANT_SOURCE
1061# 1298#
1062# @return string - Either the lowest possible source, or JAVA_PKG_WANT_SOURCE 1299# @return string - Either the lowest possible source, or JAVA_PKG_WANT_SOURCE
1063# ------------------------------------------------------------------------------ 1300# ------------------------------------------------------------------------------
1068# ------------------------------------------------------------------------------ 1305# ------------------------------------------------------------------------------
1069# @ebuild-function java-pkg_get-target 1306# @ebuild-function java-pkg_get-target
1070# 1307#
1071# Determines what target version should be used, for passing to -target. 1308# Determines what target version should be used, for passing to -target.
1072# If you don't care about lower versions, you can set _WANT_TARGET to the 1309# If you don't care about lower versions, you can set _WANT_TARGET to the
1073# version of your JDK. 1310# version of your JDK.
1074# Remember doing this will mostly like cause things to break.
1075# Doesn't allow it to be lower then the one in depend.
1076# Doesn't allow it to be higher then the active vm.
1077# 1311#
1078# @return string - Either the lowest possible target, or JAVA_PKG_WANT_TARGET 1312# @return string - Either the lowest possible target, or JAVA_PKG_WANT_TARGET
1079# ------------------------------------------------------------------------------ 1313# ------------------------------------------------------------------------------
1080java-pkg_get-target() { 1314java-pkg_get-target() {
1081 local min=$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")
1082 if [[ -n "${JAVA_PKG_WANT_TARGET}" ]]; then
1083 local max="$(java-config --select-vm "${GENTOO_VM}" -g PROVIDES_VERSION)"
1084 if version_is_at_least "${min}" "${JAVA_PKG_WANT_TARGET}" && version_is_at_least "${JAVA_PKG_WANT_TARGET}" "${max}"; then
1085 echo ${JAVA_PKG_WANT_TARGET}
1086 else
1087 echo ${min}
1088 fi
1089 else
1090 echo ${min}
1091 fi
1092
1093 #echo ${JAVA_PKG_WANT_TARGET:-$(depend-java-query --get-lowest "${DEPEND}")} 1315 echo ${JAVA_PKG_WANT_TARGET:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1094} 1316}
1095 1317
1096java-pkg_get-javac() { 1318java-pkg_get-javac() {
1097 debug-print-function ${FUNCNAME} $* 1319 debug-print-function ${FUNCNAME} $*
1098 1320
1099 java-pkg_init-compiler_ 1321
1100 local compiler="${GENTOO_COMPILER}" 1322 local compiler="${GENTOO_COMPILER}"
1101 1323
1102 local compiler_executable 1324 local compiler_executable
1103 if [[ "${compiler}" = "javac" ]]; then 1325 if [[ "${compiler}" = "javac" ]]; then
1104 # nothing fancy needs to be done for javac 1326 # nothing fancy needs to be done for javac
1112 unset JAVAC 1334 unset JAVAC
1113 # try to get value of JAVAC 1335 # try to get value of JAVAC
1114 compiler_executable="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${JAVAC})" 1336 compiler_executable="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${JAVAC})"
1115 export JAVAC=${old_javac} 1337 export JAVAC=${old_javac}
1116 1338
1117 [[ -z ${compiler_executable} ]] && die "JAVAC is empty or undefined in ${compiler_env}" 1339 if [[ -z ${compiler_executable} ]]; then
1118 1340 echo "JAVAC is empty or undefined in ${compiler_env}"
1341 return 1
1342 fi
1343
1119 # check that it's executable 1344 # check that it's executable
1120 if [[ ! -x ${compiler_executable} ]]; then 1345 if [[ ! -x ${compiler_executable} ]]; then
1121 eerror "Could not find ${compiler_executable}!"
1122 die "${compiler_executable} doesn't exist, or isn't executable" 1346 echo "${compiler_executable} doesn't exist, or isn't executable"
1347 return 1
1123 fi 1348 fi
1124 else 1349 else
1125 eerror "Could not find environment file for ${compiler}" 1350 echo "Could not find environment file for ${compiler}"
1126 die "Could not find ${compiler_env}" 1351 return 1
1127 fi 1352 fi
1128 fi 1353 fi
1129 echo ${compiler_executable} 1354 echo ${compiler_executable}
1130} 1355}
1131 1356
1132# ------------------------------------------------------------------------------ 1357# ------------------------------------------------------------------------------
1133# @ebuild-function java-pkg_javac-args 1358# @ebuild-function java-pkg_javac-args
1134# 1359#
1135# If an ebuild uses javac directly, instead of using ejavac, it should call this 1360# If an ebuild uses javac directly, instead of using ejavac, it should call this
1136# to know what -source/-target to use. 1361# to know what -source/-target to use.
1137# 1362#
1138# @return string - arguments to pass to javac, complete with -target and -source 1363# @return string - arguments to pass to javac, complete with -target and -source
1141 debug-print-function ${FUNCNAME} $* 1366 debug-print-function ${FUNCNAME} $*
1142 1367
1143 local want_source="$(java-pkg_get-source)" 1368 local want_source="$(java-pkg_get-source)"
1144 local want_target="$(java-pkg_get-target)" 1369 local want_target="$(java-pkg_get-target)"
1145 1370
1146 local source_str="-source ${want_source}" 1371 local source_str="-source ${want_source}"
1147 local target_str="-target ${want_target}" 1372 local target_str="-target ${want_target}"
1148 1373
1149 debug-print "want source: ${want_source}" 1374 debug-print "want source: ${want_source}"
1150 debug-print "want target: ${want_target}" 1375 debug-print "want target: ${want_target}"
1151 1376
1152 if [[ -z "${want_source}" || -z "${want_target}" ]]; then 1377 if [[ -z "${want_source}" || -z "${want_target}" ]]; then
1153 debug-print "could not find valid -source/-target values" 1378 debug-print "could not find valid -source/-target values for javac"
1154 die "Could not find valid -source/-target values" 1379 echo "Could not find valid -source/-target values for javac"
1380 return 1
1155 else 1381 else
1156 if java-pkg_is-vm-version-ge "1.4"; then 1382 if java-pkg_is-vm-version-ge "1.4"; then
1157 echo "${source_str} ${target_str}" 1383 echo "${source_str} ${target_str}"
1158 else 1384 else
1159 echo "${target_str}" 1385 echo "${target_str}"
1163 1389
1164# TODO document 1390# TODO document
1165java-pkg_get-jni-cflags() { 1391java-pkg_get-jni-cflags() {
1166 local flags="-I${JAVA_HOME}/include" 1392 local flags="-I${JAVA_HOME}/include"
1167 1393
1394 local platform="linux"
1395 use elibc_FreeBSD && platform="freebsd"
1396
1168 # TODO do a check that the directories are valid 1397 # TODO do a check that the directories are valid
1169 # TODO figure out how to cope with other things than linux...
1170 flags="${flags} -I${JAVA_HOME}/include/linux" 1398 flags="${flags} -I${JAVA_HOME}/include/${platform}"
1171 1399
1172 echo ${flags} 1400 echo ${flags}
1173} 1401}
1174 1402
1175java-pkg_ensure-gcj() { 1403java-pkg_ensure-gcj() {
1180 ebeep 5 1408 ebeep 5
1181 die "No GCJ support found!" 1409 die "No GCJ support found!"
1182 fi 1410 fi
1183} 1411}
1184 1412
1413java-pkg_ensure-test() {
1414 if hasq test ${FEATURES} && ! hasq -test ${FEATURES} \
1415 && hasq test ${IUSE} && ! use test;
1416 then
1417 eerror "You specified FEATURES=test, but USE=test is needed"
1418 eerror "to pull in the additional dependencies for testing"
1419 die "Need USE=test enabled"
1420 fi
1421}
1422
1423# ------------------------------------------------------------------------------
1424# @ebuild-function java-pkg_register-ant-task
1425#
1426# Register this package as ant task, so that ant will load it when no specific
1427# ANT_TASKS are specified. Note that even without this registering, all packages
1428# specified in ANT_TASKS will be loaded. Mostly used by the actual ant tasks
1429# packages, but can be also used by other ebuilds that used to symlink their
1430# .jar into /usr/share/ant-core/lib to get autoloaded, for backwards
1431# compatibility.
1432#
1433# @param --version x.y Register only for ant version x.y (otherwise for any ant
1434# version). Used by the ant-* packages to prevent loading of mismatched
1435# ant-core ant tasks after core was updated, before the tasks are updated,
1436# without a need for blockers.
1437# @param $1 Name to register as. Defaults to JAVA_PKG_NAME ($PN[-$SLOT])
1438# ------------------------------------------------------------------------------
1439java-pkg_register-ant-task() {
1440 local TASKS_DIR="tasks"
1441
1442 # check for --version x.y parameters
1443 while [[ -n "${1}" && -n "${2}" ]]; do
1444 local var="${1#--}"
1445 local val="${2}"
1446 if [[ "${var}" == "version" ]]; then
1447 TASKS_DIR="tasks-${val}"
1448 else
1449 die "Unknown parameter passed to java-pkg_register-ant-tasks: ${1} ${2}"
1450 fi
1451 shift 2
1452 done
1453
1454 local TASK_NAME="${1:-${JAVA_PKG_NAME}}"
1455
1456 dodir /usr/share/ant/${TASKS_DIR}
1457 touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}"
1458}
1459
1460# ------------------------------------------------------------------------------
1461# @internal-function java-pkg_ant-tasks-from-deps
1462#
1463# Function to determine ANT_TASKS from DEPEND variable for backwards
1464# compatibility with ebuilds that don't set ANT_TASKS before calling eant() or
1465# WANT_ANT_TASKS before inheriting java-pkg-2. If the DEPEND string contains
1466# "dev-java/ant" or "dev-java/ant-tasks", then it returns "all", otherwise
1467# "none". It's not smart enough to cope with USE flag depends but that shouldn't
1468# be a problem, the worst it can do is activace all tasks when not needed.
1469# Note that this is called only with JAVA_PKG_STRICT=1, to find ebuilds with
1470# insufficient dependencies, otherwise all available tasks are used for
1471# backwards compatilbility.
1472#
1473# @return "all" or "none"
1474# ------------------------------------------------------------------------------
1475java-pkg_ant-tasks-from-deps() {
1476 local found_ant found_ant_tasks
1477
1478 for dep in ${DEPEND}
1479 do
1480 local ant="$(awk '/(dev-java\/ant)/ { if (match($1, "(dev-java/ant)((-[0-9])+|$)", m)) print m[1] }' <<< ${dep})"
1481 [[ "${ant}" == "dev-java/ant" ]] && found_ant=true
1482 [[ "${dep}" == *"ant-tasks"* ]] && found_ant_tasks=true
1483 done
1484
1485 if [[ -n "${found_ant}" || -n "${found_ant_tasks}" ]]; then
1486 java-pkg_announce-qa-violation "The ebuild DEPENDS on deprecated ant or ant-tasks"
1487 echo "all"
1488 else
1489 # ebuild doesn't set ANT_TASKS and doesn't depend on ant-tasks or ant
1490 # so we deactivate all tasks that may be installed
1491 echo "none"
1492 fi
1493}
1494
1495# ------------------------------------------------------------------------------
1496# @internal-function java-pkg_ant-tasks-depend
1497#
1498# Translates the WANT_ANT_TASKS variable into valid dependencies.
1499# ------------------------------------------------------------------------------
1500java-pkg_ant-tasks-depend() {
1501 debug-print-function ${FUNCNAME} ${WANT_ANT_TASKS}
1502
1503 if [[ -n "${WANT_ANT_TASKS}" ]]; then
1504 local DEP=""
1505 for i in ${WANT_ANT_TASKS}
1506 do
1507 if [[ ${i} != ant-* ]]; then
1508 echo "Invalid atom in WANT_ANT_TASKS: ${i}"
1509 return 1
1510 fi
1511 DEP="${DEP}dev-java/${i} "
1512 done
1513 echo ${DEP}
1514 return 0
1515 else
1516 return 0
1517 fi
1518}
1519
1185# ------------------------------------------------------------------------------ 1520# ------------------------------------------------------------------------------
1186# @section-end helper 1521# @section-end helper
1187# ------------------------------------------------------------------------------ 1522# ------------------------------------------------------------------------------
1188 1523
1189# ------------------------------------------------------------------------------ 1524# ------------------------------------------------------------------------------
1196 1531
1197# ------------------------------------------------------------------------------ 1532# ------------------------------------------------------------------------------
1198# @ebuild-function eant 1533# @ebuild-function eant
1199# 1534#
1200# Ant wrapper function. Will use the appropriate compiler, based on user-defined 1535# Ant wrapper function. Will use the appropriate compiler, based on user-defined
1201# compiler. 1536# compiler. Will also set proper ANT_TASKS from the variable ANT_TASKS,
1202# 1537# variables:
1538# EANT_GENTOO_CLASSPATH - calls java-pkg_getjars for the value and adds to the
1539# gentoo.classpath property. Be sure to call
1540# java-ant_rewrite-classpath in src_unpack.
1541# *ANT_TASKS - used to determine ANT_TASKS before calling Ant.
1203# ------------------------------------------------------------------------------ 1542# ------------------------------------------------------------------------------
1204eant() { 1543eant() {
1205 debug-print-function ${FUNCNAME} $* 1544 debug-print-function ${FUNCNAME} $*
1206 1545
1207 local antflags 1546 # FIXME get this working
1547# if is-java-strict && [[ ! ${DEPEND} =~ "dev-java/ant" ]]; then
1548# java-pkg_announce-qa-violation \
1549# "Using eant, but not depending on dev-java/ant or dev-java/ant-core"
1550# fi
1551
1552 if ! hasq java-ant-2 ${INHERITED} && is-java-strict; then
1553 local msg="You should inherit java-ant-2 when using eant"
1554 java-pkg_announce-qa-violation ${msg}
1555 die ${msg}
1556 fi
1557
1558 local antflags="-Dnoget=true -Dmaven.mode.offline=true"
1208 java-pkg_init-compiler_ 1559 java-pkg_init-compiler_
1209 local compiler="${GENTOO_COMPILER}" 1560 local compiler="${GENTOO_COMPILER}"
1210 1561
1211 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}" 1562 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1212 1563
1214 if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then 1565 if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then
1215 die "ANT_BUILD_COMPILER undefined in ${compiler_env}" 1566 die "ANT_BUILD_COMPILER undefined in ${compiler_env}"
1216 fi 1567 fi
1217 1568
1218 if [[ ${compiler} != "javac" ]]; then 1569 if [[ ${compiler} != "javac" ]]; then
1219 antflags="-Dbuild.compiler=${build_compiler}" 1570 antflags="${antflags} -Dbuild.compiler=${build_compiler}"
1220 # Figure out any extra stuff to put on the classpath for compilers aside 1571 # Figure out any extra stuff to put on the classpath for compilers aside
1221 # from javac 1572 # from javac
1222 # ANT_BUILD_COMPILER_DEPS should be something that could be passed to 1573 # ANT_BUILD_COMPILER_DEPS should be something that could be passed to
1223 # java-config -p 1574 # java-config -p
1224 local build_compiler_deps="$(source ${JAVA_PKG_COMPILER_DIR}/${compiler} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER_DEPS})" 1575 local build_compiler_deps="$(source ${JAVA_PKG_COMPILER_DIR}/${compiler} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER_DEPS})"
1229 1580
1230 if is-java-strict; then 1581 if is-java-strict; then
1231 einfo "Disabling system classpath for ant" 1582 einfo "Disabling system classpath for ant"
1232 antflags="${antflags} -Dbuild.sysclasspath=ignore" 1583 antflags="${antflags} -Dbuild.sysclasspath=ignore"
1233 fi 1584 fi
1234 1585
1235 if [[ -n ${JAVA_PKG_DEBUG} ]]; then 1586 for arg in "${@}"; do
1236 antflags="${antflags} -debug" 1587 if [[ ${arg} = -lib ]]; then
1588 if is-java-strict; then
1589 eerror "You should not use the -lib argument to eant because it will fail"
1590 eerror "with JAVA_PKG_STRICT. Please use for example java-pkg_jar-from"
1591 eerror "or ant properties to make dependencies available."
1592 eerror "For ant tasks use WANT_ANT_TASKS or ANT_TASKS from."
1593 eerror "split ant (>=dev-java/ant-core-1.7)."
1594 die "eant -lib is deprecated/forbidden"
1595 else
1596 echo "eant -lib is deprecated. Turn JAVA_PKG_STRICT on for"
1597 echo "more info."
1598 fi
1237 fi 1599 fi
1238 1600 done
1601
1602 if has_version ">=dev-java/ant-core-1.7.0"; then
1603 # default ANT_TASKS to WANT_ANT_TASKS, if ANT_TASKS is not set explicitly
1604 ANT_TASKS="${ANT_TASKS:-${WANT_ANT_TASKS}}"
1605
1606 # override ANT_TASKS with JAVA_PKG_FORCE_ANT_TASKS if it's set
1607 ANT_TASKS="${JAVA_PKG_FORCE_ANT_TASKS:-${ANT_TASKS}}"
1608
1609 if is-java-strict; then
1610 # if ant-tasks were not set by ebuild or forced, try to determine them from depends
1611 if [[ -z "${ANT_TASKS}" ]]; then
1612 ANT_TASKS="$(java-pkg_ant-tasks-from-deps)"
1613 fi
1614 else
1615 # if ant-tasks is not set by ebuild or forced, activate all of them
1616 ANT_TASKS="${ANT_TASKS:-all}"
1617 fi
1618
1619 # at this point, ANT_TASKS should be "all", "none" or explicit list
1620 if [[ "${ANT_TASKS}" == "all" ]]; then
1621 einfo "Using all available ANT_TASKS"
1622 elif [[ "${ANT_TASKS}" == "none" ]]; then
1623 einfo "Disabling all optional ANT_TASKS"
1624 else
1625 einfo "Using following ANT_TASKS: ${ANT_TASKS}"
1626 fi
1627
1628 export ANT_TASKS
1629 fi
1630
1631 [[ -n ${JAVA_PKG_DEBUG} ]] && antflags="${antflags} --execdebug -debug"
1632 [[ -n ${PORTAGE_QUIET} ]] && antflags="${antflags} -q"
1633
1634 local gcp="${EANT_GENTOO_CLASSPATH}"
1635
1636 if [[ "${gcp}" ]]; then
1637 local cp="$(java-pkg_getjars ${gcp})"
1638 # It seems ant does not like single quotes around ${cp}
1639 antflags="${antflags} -Dgentoo.classpath=\"${cp}\""
1640 fi
1641
1239 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}" 1642 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}"
1643 debug-print "Calling ant: ${antflags} ${@}"
1240 ant ${antflags} "${@}" || die "eant failed" 1644 ant ${antflags} "${@}" || die "eant failed"
1241 1645
1242} 1646}
1243 1647
1244# ------------------------------------------------------------------------------ 1648# ------------------------------------------------------------------------------
1245# @ebuild-function ejavac 1649# @ebuild-function ejavac
1246# 1650#
1247# Javac wrapper function. Will use the appropriate compiler, based on 1651# Javac wrapper function. Will use the appropriate compiler, based on
1248# /etc/java-config/compilers.conf 1652# /etc/java-config/compilers.conf
1249# 1653#
1250# @param $@ - Arguments to be passed to the compiler 1654# @param $@ - Arguments to be passed to the compiler
1251# ------------------------------------------------------------------------------ 1655# ------------------------------------------------------------------------------
1252ejavac() { 1656ejavac() {
1253 debug-print-function ${FUNCNAME} $* 1657 debug-print-function ${FUNCNAME} $*
1254 1658
1255 # FIXME using get-javac ends up printing stuff with einfo 1659 java-pkg_init-compiler_
1660
1661 local compiler_executable
1256# local compiler_executable=$(java-pkg_get-javac) 1662 compiler_executable=$(java-pkg_get-javac)
1257 local compiler_executable="javac" 1663 if [[ ${?} != 0 ]]; then
1664 eerror "There was a problem determining compiler: ${compiler_executable}"
1665 die "get-javac failed"
1666 fi
1258 1667
1668 local javac_args
1669 javac_args="$(java-pkg_javac-args)"
1670 if [[ ${?} != 0 ]]; then
1671 eerror "There was a problem determining JAVACFLAGS: ${javac_args}"
1672 die "java-pkg_javac-args failed"
1673 fi
1674
1259 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} $(java-pkg_javac-args) "${@}" 1675 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} ${javac_args} "${@}"
1260 ${compiler_executable} $(java-pkg_javac-args) "${@}" || die "ejavac failed" 1676 ${compiler_executable} ${javac_args} "${@}" || die "ejavac failed"
1261} 1677}
1262 1678
1263# ------------------------------------------------------------------------------ 1679# ------------------------------------------------------------------------------
1264# @ebuild-function java-pkg_filter-compiler 1680# @ebuild-function java-pkg_filter-compiler
1265# 1681#
1266# Used to prevent the use of some compilers. Should be used in src_compile. 1682# Used to prevent the use of some compilers. Should be used in src_compile.
1267# Basically, it just appends onto JAVA_PKG_FILTER_COMPILER 1683# Basically, it just appends onto JAVA_PKG_FILTER_COMPILER
1268# 1684#
1269# @param $@ - compilers to filter 1685# @param $@ - compilers to filter
1270# ------------------------------------------------------------------------------ 1686# ------------------------------------------------------------------------------
1288# ------------------------------------------------------------------------------ 1704# ------------------------------------------------------------------------------
1289# @ebuild-function use_doc 1705# @ebuild-function use_doc
1290# 1706#
1291# Helper function for getting ant to build javadocs. If the user has USE=doc, 1707# Helper function for getting ant to build javadocs. If the user has USE=doc,
1292# then 'javadoc' or the argument are returned. Otherwise, there is no return. 1708# then 'javadoc' or the argument are returned. Otherwise, there is no return.
1293# 1709#
1294# The output of this should be passed to ant. 1710# The output of this should be passed to ant.
1295# 1711#
1296# Example: build javadocs by calling 'javadoc' target 1712# Example: build javadocs by calling 'javadoc' target
1297# eant $(use_doc) 1713# eant $(use_doc)
1298# Example: build javadocs by calling 'apidoc' target 1714# Example: build javadocs by calling 'apidoc' target
1303# ------------------------------------------------------------------------------ 1719# ------------------------------------------------------------------------------
1304use_doc() { 1720use_doc() {
1305 use doc && echo ${@:-javadoc} 1721 use doc && echo ${@:-javadoc}
1306} 1722}
1307 1723
1724
1308# ------------------------------------------------------------------------------ 1725# ------------------------------------------------------------------------------
1309# @section-end build 1726# @section-end build
1310# ------------------------------------------------------------------------------ 1727# ------------------------------------------------------------------------------
1311 1728
1312# ------------------------------------------------------------------------------ 1729# ------------------------------------------------------------------------------
1313# @section-begin internal 1730# @section-begin internal
1314# @section-summary Internal functions 1731# @section-summary Internal functions
1315# 1732#
1316# Do __NOT__ use any of these from an ebuild! These are only to be used from 1733# Do __NOT__ use any of these from an ebuild! These are only to be used from
1317# within the java eclasses. 1734# within the java eclasses.
1318# ------------------------------------------------------------------------------ 1735# ------------------------------------------------------------------------------
1319 1736
1320# ----------------------------------------------------------------------------- 1737# -----------------------------------------------------------------------------
1321# @function-internal java-pkg_init 1738# @function-internal java-pkg_init
1322# 1739#
1323# The purpose of this function, as the name might imply, is to initialize the 1740# The purpose of this function, as the name might imply, is to initialize the
1324# Java environment. It ensures that that there aren't any environment variables 1741# Java environment. It ensures that that there aren't any environment variables
1325# that'll muss things up. It initializes some variables, which are used 1742# that'll muss things up. It initializes some variables, which are used
1326# internally. And most importantly, it'll switch the VM if necessary. 1743# internally. And most importantly, it'll switch the VM if necessary.
1327# 1744#
1339 # TODO we will probably want to set JAVAC and JAVACFLAGS 1756 # TODO we will probably want to set JAVAC and JAVACFLAGS
1340 1757
1341 # Do some QA checks 1758 # Do some QA checks
1342 java-pkg_check-jikes 1759 java-pkg_check-jikes
1343 1760
1344 # When users have crazy classpaths some packages can fail to compile. 1761 # When users have crazy classpaths some packages can fail to compile.
1345 # and everything should work with empty CLASSPATH. 1762 # and everything should work with empty CLASSPATH.
1346 # This also helps prevent unexpected dependencies on random things 1763 # This also helps prevent unexpected dependencies on random things
1347 # from the CLASSPATH. 1764 # from the CLASSPATH.
1348 unset CLASSPATH 1765 unset CLASSPATH
1766
1767 # Unset external ANT_ stuff
1768 unset ANT_TASKS
1769 unset ANT_OPTS
1349} 1770}
1350 1771
1351# ------------------------------------------------------------------------------ 1772# ------------------------------------------------------------------------------
1352# @function-internal java-pkg-init-compiler_ 1773# @function-internal java-pkg-init-compiler_
1353# 1774#
1354# This function attempts to figure out what compiler should be used. It does 1775# This function attempts to figure out what compiler should be used. It does
1355# this by reading the file at JAVA_PKG_COMPILERS_CONF, and checking the 1776# this by reading the file at JAVA_PKG_COMPILERS_CONF, and checking the
1356# COMPILERS variable defined there. 1777# COMPILERS variable defined there.
1357# This can be overridden by a list in JAVA_PKG_FORCE_COMPILER 1778# This can be overridden by a list in JAVA_PKG_FORCE_COMPILER
1358# 1779#
1359# It will go through the list of compilers, and verify that it supports the 1780# It will go through the list of compilers, and verify that it supports the
1360# target and source that are needed. If it is not suitable, then the next 1781# target and source that are needed. If it is not suitable, then the next
1361# compiler is checked. When JAVA_PKG_FORCE_COMPILER is defined, this checking 1782# compiler is checked. When JAVA_PKG_FORCE_COMPILER is defined, this checking
1362# isn't done. 1783# isn't done.
1363# 1784#
1385 if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then 1806 if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
1386 compilers="$(source ${JAVA_PKG_COMPILERS_CONF} 1>/dev/null 2>&1; echo ${COMPILERS})" 1807 compilers="$(source ${JAVA_PKG_COMPILERS_CONF} 1>/dev/null 2>&1; echo ${COMPILERS})"
1387 else 1808 else
1388 compilers=${JAVA_PKG_FORCE_COMPILER} 1809 compilers=${JAVA_PKG_FORCE_COMPILER}
1389 fi 1810 fi
1390 1811
1391 debug-print "Read \"${compilers}\" from ${JAVA_PKG_COMPILERS_CONF}" 1812 debug-print "Read \"${compilers}\" from ${JAVA_PKG_COMPILERS_CONF}"
1392 1813
1393 # Figure out if we should announce what compiler we're using 1814 # Figure out if we should announce what compiler we're using
1394 local compiler 1815 local compiler
1395 for compiler in ${compilers}; do 1816 for compiler in ${compilers}; do
1398 if [[ ${compiler} = "javac" ]]; then 1819 if [[ ${compiler} = "javac" ]]; then
1399 debug-print "Found javac... breaking" 1820 debug-print "Found javac... breaking"
1400 export GENTOO_COMPILER="javac" 1821 export GENTOO_COMPILER="javac"
1401 break 1822 break
1402 fi 1823 fi
1403 1824
1404 if has ${compiler} ${JAVA_PKG_FILTER_COMPILER}; then 1825 if has ${compiler} ${JAVA_PKG_FILTER_COMPILER}; then
1405 if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then 1826 if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
1406 einfo "Filtering ${compiler}" 1827 einfo "Filtering ${compiler}"
1407 continue 1828 continue
1408 fi 1829 fi
1409 fi 1830 fi
1410 1831
1411 # for non-javac, we need to make sure it supports the right target and 1832 # for non-javac, we need to make sure it supports the right target and
1412 # source 1833 # source
1413 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}" 1834 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1414 if [[ -f ${compiler_env} ]]; then 1835 if [[ -f ${compiler_env} ]]; then
1415 local desired_target="$(java-pkg_get-target)" 1836 local desired_target="$(java-pkg_get-target)"
1497# Writes the package.env out to disk. 1918# Writes the package.env out to disk.
1498# 1919#
1499# ------------------------------------------------------------------------------ 1920# ------------------------------------------------------------------------------
1500# TODO change to do-write, to match everything else 1921# TODO change to do-write, to match everything else
1501java-pkg_do_write_() { 1922java-pkg_do_write_() {
1923 java-pkg_init_paths_
1502 # Create directory for package.env 1924 # Create directory for package.env
1503 dodir "${JAVA_PKG_SHAREPATH}" 1925 dodir "${JAVA_PKG_SHAREPATH}"
1504 if [[ -n "${JAVA_PKG_CLASSPATH}" || -n "${JAVA_PKG_LIBRARY}" || -f "${JAVA_PKG_DEPEND}" ]]; then 1926 if [[ -n "${JAVA_PKG_CLASSPATH}" || -n "${JAVA_PKG_LIBRARY}" || -f "${JAVA_PKG_DEPEND}" ]]; then
1505 # Create package.env 1927 # Create package.env
1506 ( 1928 (
1511 [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\"" 1933 [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\""
1512 [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\"" 1934 [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\""
1513 [[ -f "${JAVA_PKG_DEPEND}" ]] && echo "DEPEND=\"$(cat ${JAVA_PKG_DEPEND} | uniq | tr '\n' ':')\"" 1935 [[ -f "${JAVA_PKG_DEPEND}" ]] && echo "DEPEND=\"$(cat ${JAVA_PKG_DEPEND} | uniq | tr '\n' ':')\""
1514 echo "VM=\"$(echo ${RDEPEND} ${DEPEND} | sed -e 's/ /\n/g' | sed -n -e '/virtual\/\(jre\|jdk\)/ { p;q }')\"" # TODO cleanup ! 1936 echo "VM=\"$(echo ${RDEPEND} ${DEPEND} | sed -e 's/ /\n/g' | sed -n -e '/virtual\/\(jre\|jdk\)/ { p;q }')\"" # TODO cleanup !
1515 ) > "${JAVA_PKG_ENV}" 1937 ) > "${JAVA_PKG_ENV}"
1516 1938
1517 # register target/source 1939 # register target/source
1518 local target="$(java-pkg_get-target)" 1940 local target="$(java-pkg_get-target)"
1519 local source="$(java-pkg_get-source)" 1941 local source="$(java-pkg_get-source)"
1520 [[ -n ${target} ]] && echo "TARGET=\"${target}\"" >> "${JAVA_PKG_ENV}" 1942 [[ -n ${target} ]] && echo "TARGET=\"${target}\"" >> "${JAVA_PKG_ENV}"
1521 [[ -n ${source} ]] && echo "SOURCE=\"${source}\"" >> "${JAVA_PKG_ENV}" 1943 [[ -n ${source} ]] && echo "SOURCE=\"${source}\"" >> "${JAVA_PKG_ENV}"
1534 # Strip unnecessary leading and trailing colons 1956 # Strip unnecessary leading and trailing colons
1535 # TODO try to cleanup if possible 1957 # TODO try to cleanup if possible
1536 sed -e "s/=\":/=\"/" -e "s/:\"$/\"/" -i "${JAVA_PKG_ENV}" || die "Did you forget to call java_init ?" 1958 sed -e "s/=\":/=\"/" -e "s/:\"$/\"/" -i "${JAVA_PKG_ENV}" || die "Did you forget to call java_init ?"
1537 fi 1959 fi
1538} 1960}
1539
1540 1961
1541# ------------------------------------------------------------------------------ 1962# ------------------------------------------------------------------------------
1542# @internal-function java-pkg_record-jar_ 1963# @internal-function java-pkg_record-jar_
1543# 1964#
1544# Record a dependency to the package.env 1965# Record a dependency to the package.env
1588 fi 2009 fi
1589} 2010}
1590 2011
1591# ------------------------------------------------------------------------------ 2012# ------------------------------------------------------------------------------
1592# @internal-function java-pkg_expand_dir_ 2013# @internal-function java-pkg_expand_dir_
1593# 2014#
1594# Gets the full path of the file/directory's parent. 2015# Gets the full path of the file/directory's parent.
1595# @param $1 - file/directory to find parent directory for 2016# @param $1 - file/directory to find parent directory for
1596# @return - path to $1's parent directory 2017# @return - path to $1's parent directory
1597# ------------------------------------------------------------------------------ 2018# ------------------------------------------------------------------------------
1598java-pkg_expand_dir_() { 2019java-pkg_expand_dir_() {
1625# ------------------------------------------------------------------------------ 2046# ------------------------------------------------------------------------------
1626java-pkg_setup-vm() { 2047java-pkg_setup-vm() {
1627 debug-print-function ${FUNCNAME} $* 2048 debug-print-function ${FUNCNAME} $*
1628 2049
1629 local vendor="$(java-pkg_get-vm-vendor)" 2050 local vendor="$(java-pkg_get-vm-vendor)"
1630 if [[ "${vendor}" == "sun" ]] && java-pkg_is-vm-version-ge 1 5; then 2051 if [[ "${vendor}" == "sun" ]] && java-pkg_is-vm-version-ge "1.5" ; then
1631 addpredict "/dev/random" 2052 addpredict "/dev/random"
1632 elif [[ "${vendor}" == "ibm" ]]; then 2053 elif [[ "${vendor}" == "ibm" ]]; then
1633 addpredict "/proc/self/maps" 2054 addpredict "/proc/self/maps"
1634 addpredict "/proc/cpuinfo" 2055 addpredict "/proc/cpuinfo"
1635 export LANG="C" LC_ALL="C" 2056 export LANG="C" LC_ALL="C"
1684# @return - The version of the current VM 2105# @return - The version of the current VM
1685# ------------------------------------------------------------------------------ 2106# ------------------------------------------------------------------------------
1686java-pkg_get-vm-version() { 2107java-pkg_get-vm-version() {
1687 debug-print-function ${FUNCNAME} $* 2108 debug-print-function ${FUNCNAME} $*
1688 2109
1689 java-pkg_get-current-vm | sed -e "s/.*-\([0-9.]\+\).*/\1/" 2110 java-config -g PROVIDES_VERSION
1690} 2111}
1691 2112
1692# ------------------------------------------------------------------------------ 2113# ------------------------------------------------------------------------------
1693# @internal-function java-pkg_switch-vm 2114# @internal-function java-pkg_switch-vm
1694# 2115#
1695# Switch VM if we're allowed to (controlled by JAVA_PKG_ALLOW_VM_CHANGE), and 2116# Switch VM if we're allowed to (controlled by JAVA_PKG_ALLOW_VM_CHANGE), and
1696# verify that the current VM is sufficient. 2117# verify that the current VM is sufficient.
1697# Setup the environment for the VM being used. 2118# Setup the environment for the VM being used.
1698# ------------------------------------------------------------------------------ 2119# ------------------------------------------------------------------------------
1699java-pkg_switch-vm() { 2120java-pkg_switch-vm() {
2121 debug-print-function ${FUNCNAME} $*
2122
1700 if java-pkg_needs-vm; then 2123 if java-pkg_needs-vm; then
1701 # Use the VM specified by JAVA_PKG_FORCE_VM 2124 # Use the VM specified by JAVA_PKG_FORCE_VM
1702 if [[ -n ${JAVA_PKG_FORCE_VM} ]]; then 2125 if [[ -n "${JAVA_PKG_FORCE_VM}" ]]; then
1703 # If you're forcing the VM, I hope you know what your doing... 2126 # If you're forcing the VM, I hope you know what your doing...
2127 debug-print "JAVA_PKG_FORCE_VM used: ${JAVA_PKG_FORCE_VM}"
1704 export GENTOO_VM="${JAVA_PKG_FORCE_VM}" 2128 export GENTOO_VM="${JAVA_PKG_FORCE_VM}"
1705 # if we're allowed to switch the vm... 2129 # if we're allowed to switch the vm...
1706 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then 2130 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then
1707 debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}} VNEED: ${JAVA_PKG_VNEED}" 2131 debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}} VNEED: ${JAVA_PKG_VNEED}"
1708 if [[ -n ${JAVA_PKG_VNEED} ]]; then 2132 if [[ -n ${JAVA_PKG_VNEED} ]]; then
1709 export GENTOO_VM="$(depend-java-query --need-virtual "${JAVA_PKG_VNEED}" --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")" 2133 GENTOO_VM="$(depend-java-query --need-virtual "${JAVA_PKG_VNEED}" --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")"
1710 else 2134 else
1711 export GENTOO_VM="$(depend-java-query --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")" 2135 GENTOO_VM="$(depend-java-query --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")"
2136 fi
2137 if [[ -z "${GENTOO_VM}" || "${GENTOO_VM}" == "None" ]]; then
2138 eerror "Unable to determine VM for building from dependencies:"
2139 echo "NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
2140 echo "VNEED: ${JAVA_PKG_VNEED}"
2141 die "Failed to determine VM for building."
2142 else
2143 export GENTOO_VM
1712 fi 2144 fi
1713 # otherwise just make sure the current VM is sufficient 2145 # otherwise just make sure the current VM is sufficient
1714 else 2146 else
1715 java-pkg_ensure-vm-version-sufficient 2147 java-pkg_ensure-vm-version-sufficient
1716 fi 2148 fi
1717 debug-print "Using: $(java-config -f)" 2149 debug-print "Using: $(java-config -f)"
1718 2150
1719 java-pkg_setup-vm 2151 java-pkg_setup-vm
1720 2152
1721 export JAVA=$(java-config --java) 2153 export JAVA=$(java-config --java)
1722 export JAVAC=$(java-config --javac) 2154 export JAVAC=$(java-config --javac)
1723 export JAVACFLAGS="$(java-pkg_javac-args)" 2155 JAVACFLAGS="$(java-pkg_javac-args)"
2156 if [[ ${?} != 0 ]]; then
2157 eerror "There was a problem determining JAVACFLAGS: ${JAVACFLAGS}"
2158 die "java-pkg_javac-args failed"
2159 fi
1724 [[ -n ${JAVACFLAGS_EXTRA} ]] && export JAVACFLAGS="${JAVACFLAGS_EXTRA} ${JAVACFLAGS}" 2160 [[ -n ${JAVACFLAGS_EXTRA} ]] && JAVACFLAGS="${JAVACFLAGS_EXTRA} ${JAVACFLAGS}"
2161 export JAVACFLAGS
1725 2162
1726 export JAVA_HOME="$(java-config -g JAVA_HOME)" 2163 export JAVA_HOME="$(java-config -g JAVA_HOME)"
1727 export JDK_HOME=${JAVA_HOME} 2164 export JDK_HOME=${JAVA_HOME}
1728 2165
1729 #TODO If you know a better solution let us know. 2166 #TODO If you know a better solution let us know.
1730 java-pkg_append_ LD_LIBRARY_PATH "$(java-config -g LDPATH)" 2167 java-pkg_append_ LD_LIBRARY_PATH "$(java-config -g LDPATH)"
1731 2168
1732 local tann="${T}/announced-vm" 2169 local tann="${T}/announced-vm"
1733 if [[ -n "${JAVA_PKG_DEBUG}" ]] || [[ ! -f "${tann}" ]] ; then 2170 if [[ -n "${JAVA_PKG_DEBUG}" ]] || [[ ! -f "${tann}" ]] ; then
1734 # Add a check for setup/preinst phase... to avoid duplicate outputs 2171 # Add a check for setup/preinst phase... to avoid duplicate outputs
1735 # for when FEATURES=buildpkg 2172 # for when FEATURES=buildpkg
1736 if [[ ${EBUILD_PHASE} != "setup" && ${EBUILD_PHASE} != "preinst" && ${EBUILD_PHASE} != "postinst" ]]; 2173 if [[ ${EBUILD_PHASE} != "setup" && ${EBUILD_PHASE} != "preinst" && ${EBUILD_PHASE} != "postinst" ]];
1775 einfo "Classes" 2212 einfo "Classes"
1776 find "${S}" -type f -name '*.class' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR}," 2213 find "${S}" -type f -name '*.class' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
1777 fi 2214 fi
1778} 2215}
1779 2216
1780# TODO document 2217# ------------------------------------------------------------------------------
2218# @internal-function java-pkg_verify-classes
2219#
1781# Verify that the classes were compiled for the right source / target 2220# Verify that the classes were compiled for the right source / target. Dies if
2221# not.
2222# @param $1 (optional) - the file to check, otherwise checks whole ${D}
2223# ------------------------------------------------------------------------------
1782java-pkg_verify-classes() { 2224java-pkg_verify-classes() {
1783 ebegin "Verifying java class versions"
1784 #$(find ${D} -type f -name '*.jar' -o -name '*.class') 2225 #$(find ${D} -type f -name '*.jar' -o -name '*.class')
1785 class-version-verify.py -t $(java-pkg_get-target) -r ${D} 2226 local target=$(java-pkg_get-target)
2227 local result
2228 local log="${T}/class-version-verify.log"
2229 if [[ -n "${1}" ]]; then
2230 class-version-verify.py -v -t ${target} "${1}" > "${log}"
1786 result=$? 2231 result=$?
1787 eend ${result}
1788 if [[ ${result} == 0 ]]; then
1789 einfo "All good"
1790 else 2232 else
1791 ewarn "Possible problem" 2233 ebegin "Verifying java class versions (target: ${target})"
1792 die "Bad class files found" 2234 class-version-verify.py -v -t ${target} -r "${D}" > "${log}"
2235 result=$?
2236 eend ${result}
1793 fi 2237 fi
2238 [[ -n ${JAVA_PKG_DEBUG} ]] && cat "${log}"
2239 if [[ ${result} != 0 ]]; then
2240 eerror "Incorrect bytecode version found"
2241 [[ -n "${1}" ]] && eerror "in file: ${1}"
2242 eerror "See ${log} for more details."
2243 die "Incorrect bytecode found"
2244 fi
1794} 2245}
1795
1796 2246
1797# ------------------------------------------------------------------------------ 2247# ------------------------------------------------------------------------------
1798# @section-end internal 2248# @section-end internal
1799# ------------------------------------------------------------------------------ 2249# ------------------------------------------------------------------------------
1800 2250
1832 let "JAVA_PKG_QA_VIOLATIONS+=1" 2282 let "JAVA_PKG_QA_VIOLATIONS+=1"
1833 export JAVA_PKG_QA_VIOLATIONS 2283 export JAVA_PKG_QA_VIOLATIONS
1834} 2284}
1835 2285
1836is-java-strict() { 2286is-java-strict() {
1837 hasq java-strict ${FEATURES}; 2287 [[ -n ${JAVA_PKG_STRICT} ]]
1838 return $? 2288 return $?
1839} 2289}
1840 2290
1841# ------------------------------------------------------------------------------ 2291# ------------------------------------------------------------------------------
1842# @eclass-end 2292# @eclass-end

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.56

  ViewVC Help
Powered by ViewVC 1.1.20