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

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

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

Revision 1.33 Revision 1.85
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.33 2006/12/07 02:27:22 flameeyes Exp $ 9# $Header: /var/cvsroot/gentoo-x86/eclass/java-utils-2.eclass,v 1.85 2007/05/25 10:27:57 caster Exp $
10 10
11 11
12# ----------------------------------------------------------------------------- 12# -----------------------------------------------------------------------------
13# @eclass-begin 13# @eclass-begin
14# @eclass-shortdesc Java Utility eclass 14# @eclass-shortdesc Java Utility eclass
36# ----------------------------------------------------------------------------- 36# -----------------------------------------------------------------------------
37 37
38# Make sure we use java-config-2 38# Make sure we use java-config-2
39export WANT_JAVA_CONFIG="2" 39export WANT_JAVA_CONFIG="2"
40 40
41# 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# -----------------------------------------------------------------------------
61# @variable-internal JAVA_PKG_PORTAGE_DEP
62#
63# The version of portage we need to function properly. At this moment it's
64# portage with phase hooks support.
65# -----------------------------------------------------------------------------
42JAVA_PKG_PORTAGE_DEP=">=sys-apps/portage-2.1_pre1" 66JAVA_PKG_PORTAGE_DEP=">=sys-apps/portage-2.1_pre1"
43 67
44# ----------------------------------------------------------------------------- 68# -----------------------------------------------------------------------------
45# @variable-internal JAVA_PKG_E_DEPEND 69# @variable-internal JAVA_PKG_E_DEPEND
46# 70#
47# 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
48# 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. We also need a recent version
49# portage, that includes phase hooks. 73# portage, that includes phase hooks.
50# ----------------------------------------------------------------------------- 74# -----------------------------------------------------------------------------
51JAVA_PKG_E_DEPEND=">=dev-java/java-config-2.0.19-r1 ${JAVA_PKG_PORTAGE_DEP}" 75JAVA_PKG_E_DEPEND=">=dev-java/java-config-2.0.31 ${JAVA_PKG_PORTAGE_DEP}"
52 76
53# ----------------------------------------------------------------------------- 77# -----------------------------------------------------------------------------
54# @variable-external JAVA_PKG_ALLOW_VM_CHANGE 78# @variable-external JAVA_PKG_ALLOW_VM_CHANGE
55# @variable-default yes 79# @variable-default yes
56# 80#
130# @note This should only be used internally or for testing. 154# @note This should only be used internally or for testing.
131# @example Use jikes and javac, in that order 155# @example Use jikes and javac, in that order
132# JAVA_PKG_FORCE_COMPILER="jikes javac" 156# JAVA_PKG_FORCE_COMPILER="jikes javac"
133# ----------------------------------------------------------------------------- 157# -----------------------------------------------------------------------------
134 158
159# -----------------------------------------------------------------------------
160# @variable-external JAVA_PKG_FORCE_ANT_TASKS
161#
162# An $IFS separated list of ant tasks. Can be set in environment before calling
163# emerge/ebuild to override variables set in ebuild, mainly for testing before
164# putting the resulting (WANT_)ANT_TASKS into ebuild. Affects only ANT_TASKS in
165# eant() call, not the dependencies specified in WANT_ANT_TASKS.
166#
167# @example JAVA_PKG_FORCE_ANT_TASKS="ant-junit ant-trax" \
168# ebuild foo.ebuild compile
169#
170# @seealso WANT_ANT_TASKS
171# -----------------------------------------------------------------------------
172
135# TODO document me 173# TODO document me
136JAVA_PKG_QA_VIOLATIONS=0 174JAVA_PKG_QA_VIOLATIONS=0
137 175
138# ----------------------------------------------------------------------------- 176# -----------------------------------------------------------------------------
139# @section-end variables 177# @section-end variables
146# 184#
147# These are used to install Java-related things, such as jars, Javadocs, JNI 185# These are used to install Java-related things, such as jars, Javadocs, JNI
148# libraries, etc. 186# libraries, etc.
149# ----------------------------------------------------------------------------- 187# -----------------------------------------------------------------------------
150 188
189# -----------------------------------------------------------------------------
190# @ebuild-function java-pkg_doexamples
191#
192# Installs given arguments to /usr/share/doc/${PF}/examples
193# If you give it only one parameter and it is a directory it will install
194# everything in that directory to the examples directory.
195#
196# @example
197# java-pkg_doexamples demo
198# java-pkg_doexamples demo/* examples/*
199#
200# @param $* - list of files to install
201# ------------------------------------------------------------------------------
202java-pkg_doexamples() {
203 debug-print-function ${FUNCNAME} $*
204
205 [[ ${#} -lt 1 ]] && die "At least one argument needed"
206
207 java-pkg_check-phase install
208
209 local dest=/usr/share/doc/${PF}/examples
210 if [[ ${#} = 1 && -d ${1} ]]; then
211 ( # dont want to pollute calling env
212 insinto "${dest}"
213 doins -r ${1}/*
214 ) || die "Installing examples failed"
215 else
216 ( # dont want to pollute calling env
217 insinto "${dest}"
218 doins -r "$@"
219 ) || die "Installing examples failed"
220 fi
221}
151 222
152# ----------------------------------------------------------------------------- 223# -----------------------------------------------------------------------------
153# @ebuild-function java-pkg_dojar 224# @ebuild-function java-pkg_dojar
154# 225#
155# Installs any number of jars. 226# Installs any number of jars.
174 # Create JARDEST if it doesn't exist 245 # Create JARDEST if it doesn't exist
175 dodir ${JAVA_PKG_JARDEST} 246 dodir ${JAVA_PKG_JARDEST}
176 247
177 local jar 248 local jar
178 # for each jar 249 # for each jar
179 for jar in "$@"; do 250 for jar in "${@}"; do
180 local jar_basename=$(basename "${jar}") 251 local jar_basename=$(basename "${jar}")
181 252
182 java-pkg_check-versioned-jar ${jar_basename} 253 java-pkg_check-versioned-jar ${jar_basename}
183 254
184 # check if it exists 255 # check if it exists
185 if [[ -e "${jar}" ]] ; then 256 if [[ -e "${jar}" ]] ; then
257 # Don't overwrite if jar has already been installed with the same
258 # name
259 local dest="${D}${JAVA_PKG_JARDEST}/${jar_basename}"
260 if [[ -e "${dest}" ]]; then
261 ewarn "Overwriting ${dest}"
262 fi
263
186 # install it into JARDEST if it's a non-symlink 264 # install it into JARDEST if it's a non-symlink
187 if [[ ! -L "${jar}" ]] ; then 265 if [[ ! -L "${jar}" ]] ; then
266 #but first check class version when in strict mode.
267 is-java-strict && java-pkg_verify-classes "${jar}"
268
188 INSDESTTREE="${JAVA_PKG_JARDEST}" \ 269 INSDESTTREE="${JAVA_PKG_JARDEST}" \
189 doins "${jar}" || die "failed to install ${jar}" 270 doins "${jar}" || die "failed to install ${jar}"
190 java-pkg_append_ JAVA_PKG_CLASSPATH "${JAVA_PKG_JARDEST}/${jar_basename}" 271 java-pkg_append_ JAVA_PKG_CLASSPATH "${JAVA_PKG_JARDEST}/${jar_basename}"
191 debug-print "installed ${jar} to ${D}${JAVA_PKG_JARDEST}" 272 debug-print "installed ${jar} to ${D}${JAVA_PKG_JARDEST}"
192 # make a symlink to the original jar if it's symlink 273 # make a symlink to the original jar if it's symlink
203 284
204 java-pkg_do_write_ 285 java-pkg_do_write_
205} 286}
206 287
207 288
289# ------------------------------------------------------------------------------
290# @internal-function depend-java-query
291#
292# Wrapper for the depend-java-query binary to enable passing USE in env.
293# Using env variables keeps this eclass working with java-config versions that
294# do not handle use flags.
295# ------------------------------------------------------------------------------
296
297depend-java-query() {
298 # Used to have a which call here but it caused endless loops for some people
299 # that had some weird bashrc voodoo for which.
300 USE="${USE}" /usr/bin/depend-java-query "${@}"
301}
208 302
209# ------------------------------------------------------------------------------ 303# ------------------------------------------------------------------------------
210# @ebuild-function java-pkg_regjar 304# @ebuild-function java-pkg_regjar
211# 305#
212# Records an already installed jar in the package.env 306# Records an already installed jar in the package.env
243 [[ ${#} -lt 1 ]] && die "at least one argument needed" 337 [[ ${#} -lt 1 ]] && die "at least one argument needed"
244 338
245 java-pkg_init_paths_ 339 java-pkg_init_paths_
246 340
247 local jar jar_dir jar_file 341 local jar jar_dir jar_file
248 for jar in "$@"; do 342 for jar in "${@}"; do
249 # TODO use java-pkg_check-versioned-jar 343 # TODO use java-pkg_check-versioned-jar
250 if [[ -e "${jar}" ]]; then 344 if [[ -e "${jar}" || -e "${D}${jar}" ]]; then
345 [[ -d "${jar}" || -d "${D}${jar}" ]] \
346 && die "Called ${FUNCNAME} on a directory $*"
347
348 #check that class version correct when in strict mode
349 is-java-strict && java-pkg_verify-classes "${jar}"
350
251 # nelchael: we should strip ${D} in this case too, here's why: 351 # nelchael: we should strip ${D} in this case too, here's why:
252 # imagine such call: 352 # imagine such call:
253 # java-pkg_regjar ${D}/opt/java/*.jar 353 # java-pkg_regjar ${D}/opt/java/*.jar
254 # such call will fall into this case (-e ${jar}) and will 354 # such call will fall into this case (-e ${jar}) and will
255 # record paths with ${D} in package.env 355 # record paths with ${D} in package.env
256 java-pkg_append_ JAVA_PKG_CLASSPATH "${jar#${D}}" 356 java-pkg_append_ JAVA_PKG_CLASSPATH "${jar#${D}}"
257 elif [[ -e "${D}${jar}" ]]; then
258 java-pkg_append_ JAVA_PKG_CLASSPATH "${jar#${D}}"
259 else 357 else
358 if [[ ${jar} = *\** ]]; then
359 eerror "The argument ${jar} to ${FUNCNAME}"
360 eerror "has * in it. If you want it to glob in"
361 eerror '${D} add ${D} to the argument.'
362 fi
260 die "${jar} does not exist" 363 die "${jar} does not exist"
261 fi 364 fi
262 done 365 done
263 366
264 java-pkg_do_write_ 367 java-pkg_do_write_
265} 368}
266
267 369
268# ------------------------------------------------------------------------------ 370# ------------------------------------------------------------------------------
269# @ebuild-function java-pkg_newjar 371# @ebuild-function java-pkg_newjar
270# 372#
271# Installs a jar with a new name 373# Installs a jar with a new name
282 local original_jar="${1}" 384 local original_jar="${1}"
283 local new_jar="${2:-${PN}.jar}" 385 local new_jar="${2:-${PN}.jar}"
284 local new_jar_dest="${T}/${new_jar}" 386 local new_jar_dest="${T}/${new_jar}"
285 387
286 [[ -z ${original_jar} ]] && die "Must specify a jar to install" 388 [[ -z ${original_jar} ]] && die "Must specify a jar to install"
287 [[ ! -f ${original_jar} ]] && die "${original_jar} does not exist!" 389 [[ ! -f ${original_jar} ]] \
390 && die "${original_jar} does not exist or is not a file!"
288 391
289 rm -f "${new_jar_dest}" || die "Failed to remove ${new_jar_dest}" 392 rm -f "${new_jar_dest}" || die "Failed to remove ${new_jar_dest}"
290 cp "${original_jar}" "${new_jar_dest}" \ 393 cp "${original_jar}" "${new_jar_dest}" \
291 || die "Failed to copy ${original_jar} to ${new_jar_dest}" 394 || die "Failed to copy ${original_jar} to ${new_jar_dest}"
292 java-pkg_dojar "${new_jar_dest}" 395 java-pkg_dojar "${new_jar_dest}"
341 java-pkg_append_ JAVA_PKG_LIBRARY "${JAVA_PKG_LIBDEST}" 444 java-pkg_append_ JAVA_PKG_LIBRARY "${JAVA_PKG_LIBDEST}"
342 debug-print "Installing ${lib} to ${JAVA_PKG_LIBDEST}" 445 debug-print "Installing ${lib} to ${JAVA_PKG_LIBDEST}"
343 # otherwise make a symlink to the symlink's origin 446 # otherwise make a symlink to the symlink's origin
344 else 447 else
345 # TODO use dosym 448 # TODO use dosym
449 ln -s "$(readlink "${lib}")" \
346 ln -s "$(readlink "${lib}")" "${D}${JAVA_PKG_LIBDEST}/$(basename "${lib}")" 450 "${D}${JAVA_PKG_LIBDEST}/$(basename "${lib}")"
347 debug-print "${lib} is a symlink, linking accordanly" 451 debug-print "${lib} is a symlink, linking accordanly"
348 fi 452 fi
349 # otherwise die 453 # otherwise die
350 else 454 else
351 die "${lib} does not exist" 455 die "${lib} does not exist"
452# @example: 556# @example:
453# java-pkg_dojavadoc docs/api 557# java-pkg_dojavadoc docs/api
454# 558#
455# ------------------------------------------------------------------------------ 559# ------------------------------------------------------------------------------
456java-pkg_dojavadoc() { 560java-pkg_dojavadoc() {
561 debug-print-function ${FUNCNAME} $*
457 local dir="$1" 562 local dir="$1"
563
564 # QA checks
458 565
459 java-pkg_check-phase install 566 java-pkg_check-phase install
460 567
461 [[ -z "${dir}" ]] && die "Must specify a directory!" 568 [[ -z "${dir}" ]] && die "Must specify a directory!"
462 [[ ! -d "${dir}" ]] && die "${dir} does not exist, or isn't a directory!" 569 [[ ! -d "${dir}" ]] && die "${dir} does not exist, or isn't a directory!"
570 if [[ ! -e "${dir}/index.html" ]]; then
571 local msg="No index.html in javadoc directory"
572 ewarn "${msg}"
573 is-java-strict && die "${msg}"
574 fi
575
576 # Renaming to match our directory layout
463 577
464 local dir_to_install="${dir}" 578 local dir_to_install="${dir}"
465 if [[ "$(basename "${dir}")" != "api" ]]; then 579 if [[ "$(basename "${dir}")" != "api" ]]; then
466 dir_to_install="${T}/api" 580 dir_to_install="${T}/api"
467 # TODO use doins 581 # TODO use doins
468 cp -r "${dir}" "${dir_to_install}" || die "cp failed" 582 cp -r "${dir}" "${dir_to_install}" || die "cp failed"
469 fi 583 fi
584
585 # Actual installation
470 586
471 java-pkg_dohtml -r ${dir_to_install} 587 java-pkg_dohtml -r ${dir_to_install}
472} 588}
473 589
474# ------------------------------------------------------------------------------ 590# ------------------------------------------------------------------------------
492# FIXME apparently this fails if you give it an empty directories 608# FIXME apparently this fails if you give it an empty directories
493java-pkg_dosrc() { 609java-pkg_dosrc() {
494 debug-print-function ${FUNCNAME} $* 610 debug-print-function ${FUNCNAME} $*
495 611
496 [ ${#} -lt 1 ] && die "At least one argument needed" 612 [ ${#} -lt 1 ] && die "At least one argument needed"
497 if ! hasq source ${IUSE}; then
498 echo "Java QA Notice: ${FUNCNAME} called without source in IUSE"
499 fi
500 613
501 java-pkg_check-phase install 614 java-pkg_check-phase install
502 615
503 [[ ${#} -lt 1 ]] && die "At least one argument needed" 616 [[ ${#} -lt 1 ]] && die "At least one argument needed"
617
618 if ! [[ ${DEPEND} = *app-arch/zip* ]]; then
619 local msg="${FUNCNAME} called without app-arch/zip in DEPEND"
620 if is-java-strict; then
621 eerror "${msg}"
622 die "${msg}"
623 else
624 echo "${msg}"
625 echo "Please report this to http://bugs.gentoo.org."
626 fi
627 fi
504 628
505 java-pkg_init_paths_ 629 java-pkg_init_paths_
506 630
507 local zip_name="${PN}-src.zip" 631 local zip_name="${PN}-src.zip"
508 local zip_path="${T}/${zip_name}" 632 local zip_path="${T}/${zip_name}"
509 local dir 633 local dir
510 for dir in ${@}; do 634 for dir in "${@}"; do
511 local dir_parent=$(dirname "${dir}") 635 local dir_parent=$(dirname "${dir}")
512 local dir_name=$(basename "${dir}") 636 local dir_name=$(basename "${dir}")
513 pushd ${dir_parent} > /dev/null || die "problem entering ${dir_parent}" 637 pushd ${dir_parent} > /dev/null || die "problem entering ${dir_parent}"
514 zip -q -r ${zip_path} ${dir_name} -i '*.java' 638 zip -q -r ${zip_path} ${dir_name} -i '*.java'
515 local result=$? 639 local result=$?
540# @param $1 - filename of launcher to create 664# @param $1 - filename of launcher to create
541# @param $2 - options, as follows: 665# @param $2 - options, as follows:
542# --main the.main.class.too.start 666# --main the.main.class.too.start
543# --jar /the/jar/too/launch.jar or just <name>.jar 667# --jar /the/jar/too/launch.jar or just <name>.jar
544# --java_args 'Extra arguments to pass to java' 668# --java_args 'Extra arguments to pass to java'
545# --pkg_args 'Extra arguments too pass to the package' 669# --pkg_args 'Extra arguments to pass to the package'
546# --pwd 670# --pwd Directory the launcher changes to before executing java
547# -into 671# -into Directory to install the launcher to, instead of /usr/bin
548# -pre 672# -pre Prepend contents of this file to the launcher
549# ------------------------------------------------------------------------------ 673# ------------------------------------------------------------------------------
550java-pkg_dolauncher() { 674java-pkg_dolauncher() {
551 debug-print-function ${FUNCNAME} $* 675 debug-print-function ${FUNCNAME} $*
552 676
553 java-pkg_check-phase install 677 java-pkg_check-phase install
565 local var_tmp="${T}/launcher_variables_tmp" 689 local var_tmp="${T}/launcher_variables_tmp"
566 local target_dir pre 690 local target_dir pre
567 691
568 # Process the other the rest of the arguments 692 # Process the other the rest of the arguments
569 while [[ -n "${1}" && -n "${2}" ]]; do 693 while [[ -n "${1}" && -n "${2}" ]]; do
570 local var=${1} value=${2} 694 local var="${1}" value="${2}"
571 if [[ "${var:0:2}" == "--" ]]; then 695 if [[ "${var:0:2}" == "--" ]]; then
572 local var=${var:2} 696 local var=${var:2}
573 echo "gjl_${var}=\"${value}\"" >> "${var_tmp}" 697 echo "gjl_${var}=\"${value}\"" >> "${var_tmp}"
574 local gjl_${var}="${value}" 698 local gjl_${var}="${value}"
575 elif [[ "${var}" == "-into" ]]; then 699 elif [[ "${var}" == "-into" ]]; then
594 fi 718 fi
595 fi 719 fi
596 720
597 # Write the actual script 721 # Write the actual script
598 echo "#!/bin/bash" > "${target}" 722 echo "#!/bin/bash" > "${target}"
599 [[ -n "${pre}" ]] && [[ -f "${pre}" ]] && cat "${pre}" >> "${target}" 723 if [[ -n "${pre}" ]]; then
724 if [[ -f "${pre}" ]]; then
725 cat "${pre}" >> "${target}"
726 else
727 die "-pre specified file '${pre}' does not exist"
728 fi
729 fi
600 echo "gjl_package=${JAVA_PKG_NAME}" >> "${target}" 730 echo "gjl_package=${JAVA_PKG_NAME}" >> "${target}"
601 cat "${var_tmp}" >> "${target}" 731 cat "${var_tmp}" >> "${target}"
602 rm -f "${var_tmp}" 732 rm -f "${var_tmp}"
603 echo "source /usr/share/java-config-2/launcher/launcher.bash" >> "${target}" 733 echo "source /usr/share/java-config-2/launcher/launcher.bash" >> "${target}"
604 734
696# Example: get a specific jar from xerces slot 2, and name it diffrently 826# Example: get a specific jar from xerces slot 2, and name it diffrently
697# java-pkg_jar-from xerces-2 xml-apis.jar xml.jar 827# java-pkg_jar-from xerces-2 xml-apis.jar xml.jar
698# Example: get junit.jar which is needed only for building 828# Example: get junit.jar which is needed only for building
699# java-pkg_jar-from --build-only junit junit.jar 829# java-pkg_jar-from --build-only junit junit.jar
700# 830#
701# @param $1 - (optional) "--build-only" makes the jar(s) not added into 831# @param $opt
702# package.env DEPEND line. 832# --build-only - makes the jar(s) not added into package.env DEPEND line.
703# @param $1 - Package to get jars from. 833# (assumed automatically when called inside src_test)
834# --with-dependencies - get jars also from requested package's dependencies
835# transitively.
836# --into $dir - symlink jar(s) into $dir (must exist) instead of .
837# @param $1 - Package to get jars from, or comma-separated list of packages in
838# case other parameters are not used.
704# @param $2 - jar from package. If not specified, all jars will be used. 839# @param $2 - jar from package. If not specified, all jars will be used.
705# @param $3 - When a single jar is specified, destination filename of the 840# @param $3 - When a single jar is specified, destination filename of the
706# symlink. Defaults to the name of the jar. 841# symlink. Defaults to the name of the jar.
707# ------------------------------------------------------------------------------ 842# ------------------------------------------------------------------------------
708# TODO could probably be cleaned up a little 843# TODO could probably be cleaned up a little
709java-pkg_jar-from() { 844java-pkg_jar-from() {
710 debug-print-function ${FUNCNAME} $* 845 debug-print-function ${FUNCNAME} $*
711 846
712 local build_only="" 847 local build_only=""
848 local destdir="."
849 local deep=""
713 850
851 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
852
853 while [[ "${1}" == --* ]]; do
714 if [[ "${1}" = "--build-only" ]]; then 854 if [[ "${1}" = "--build-only" ]]; then
715 build_only="true" 855 build_only="build"
856 elif [[ "${1}" = "--with-dependencies" ]]; then
857 deep="--with-dependencies"
858 elif [[ "${1}" = "--into" ]]; then
859 destdir="${2}"
860 shift
861 else
862 die "java-pkg_jar-from called with unknown parameter: ${1}"
863 fi
716 shift 864 shift
717 fi 865 done
718 866
719 local target_pkg="${1}" target_jar="${2}" destjar="${3}" 867 local target_pkg="${1}" target_jar="${2}" destjar="${3}"
720 868
721 [[ -z ${target_pkg} ]] && die "Must specify a package" 869 [[ -z ${target_pkg} ]] && die "Must specify a package"
722 870
723 # default destjar to the target jar 871 # default destjar to the target jar
724 [[ -z "${destjar}" ]] && destjar="${target_jar}" 872 [[ -z "${destjar}" ]] && destjar="${target_jar}"
725 873
726 local error_msg="There was a problem getting the classpath for ${target_pkg}." 874 local error_msg="There was a problem getting the classpath for ${target_pkg}."
727 local classpath 875 local classpath
728 classpath="$(java-config --classpath=${target_pkg})" 876 classpath="$(java-config ${deep} --classpath=${target_pkg})"
729 [[ $? != 0 ]] && die ${error_msg} 877 [[ $? != 0 ]] && die ${error_msg}
878
879 # When we have commas this functions is called to bring jars from multiple
880 # packages. This affects recording of dependencencies performed later
881 # which expects one package only, so we do it here.
882 if [[ ${target_pkg} = *,* ]]; then
883 for pkg in ${target_pkg//,/ }; do
884 java-pkg_ensure-dep "${build_only}" "${pkg}"
885 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${pkg}"
886 done
887 # setting this disables further record-jar_ calls later
888 build_only="build"
889 else
890 java-pkg_ensure-dep "${build_only}" "${target_pkg}"
891 fi
892
893 pushd ${destdir} > /dev/null \
894 || die "failed to change directory to ${destdir}"
730 895
731 local jar 896 local jar
732 for jar in ${classpath//:/ }; do 897 for jar in ${classpath//:/ }; do
733 local jar_name=$(basename "${jar}") 898 local jar_name=$(basename "${jar}")
734 if [[ ! -f "${jar}" ]] ; then 899 if [[ ! -f "${jar}" ]] ; then
745 elif [[ "${jar_name}" == "${target_jar}" ]] ; then 910 elif [[ "${jar_name}" == "${target_jar}" ]] ; then
746 [[ -f "${destjar}" ]] && rm "${destjar}" 911 [[ -f "${destjar}" ]] && rm "${destjar}"
747 ln -snf "${jar}" "${destjar}" \ 912 ln -snf "${jar}" "${destjar}" \
748 || die "Failed to make symlink from ${jar} to ${destjar}" 913 || die "Failed to make symlink from ${jar} to ${destjar}"
749 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${target_pkg}" "${jar}" 914 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${target_pkg}" "${jar}"
915 popd > /dev/null
750 return 0 916 return 0
751 fi 917 fi
752 done 918 done
919 popd > /dev/null
753 # if no target was specified, we're ok 920 # if no target was specified, we're ok
754 if [[ -z "${target_jar}" ]] ; then 921 if [[ -z "${target_jar}" ]] ; then
755 return 0 922 return 0
756 # otherwise, die bitterly 923 # otherwise, die bitterly
757 else 924 else
781# Example: Get the classpath for xerces-2 and xalan, 948# Example: Get the classpath for xerces-2 and xalan,
782# java-pkg_getjars xerces-2,xalan 949# java-pkg_getjars xerces-2,xalan
783# Example Return: 950# Example Return:
784# /usr/share/xerces-2/lib/xml-apis.jar:/usr/share/xerces-2/lib/xmlParserAPIs.jar:/usr/share/xalan/lib/xalan.jar 951# /usr/share/xerces-2/lib/xml-apis.jar:/usr/share/xerces-2/lib/xmlParserAPIs.jar:/usr/share/xalan/lib/xalan.jar
785# 952#
786# @param $1 - (optional) "--build-only" makes the jar(s) not added into 953# @param $opt
787# package.env DEPEND line. 954# --build-only - makes the jar(s) not added into package.env DEPEND line.
955# (assumed automatically when called inside src_test)
956# --with-dependencies - get jars also from requested package's dependencies
957# transitively.
788# @param $2 - list of packages to get jars from 958# @param $1 - list of packages to get jars from
789# (passed to java-config --classpath) 959# (passed to java-config --classpath)
790# ------------------------------------------------------------------------------ 960# ------------------------------------------------------------------------------
791java-pkg_getjars() { 961java-pkg_getjars() {
792 debug-print-function ${FUNCNAME} $* 962 debug-print-function ${FUNCNAME} $*
793 963
794 [[ ${#} -lt 1 || ${#} -gt 2 ]] && die "${FUNCNAME} takes only one or two arguments" 964 local build_only=""
965 local deep=""
795 966
967 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
968
969 while [[ "${1}" == --* ]]; do
796 if [[ "${1}" = "--build-only" ]]; then 970 if [[ "${1}" = "--build-only" ]]; then
797 local build_only="true" 971 build_only="build"
972 elif [[ "${1}" = "--with-dependencies" ]]; then
973 deep="--with-dependencies"
974 else
975 die "java-pkg_jar-from called with unknown parameter: ${1}"
976 fi
798 shift 977 shift
799 fi 978 done
979
980 [[ ${#} -ne 1 ]] && die "${FUNCNAME} takes only one argument besides --*"
981
800 982
801 local classpath pkgs="${1}" 983 local classpath pkgs="${1}"
802 jars="$(java-config --classpath=${pkgs})" 984 jars="$(java-config ${deep} --classpath=${pkgs})"
803 [[ -z "${jars}" ]] && die "java-config --classpath=${pkgs} failed" 985 [[ $? != 0 || -z "${jars}" ]] && die "java-config --classpath=${pkgs} failed"
804 debug-print "${pkgs}:${jars}" 986 debug-print "${pkgs}:${jars}"
987
988 for pkg in ${pkgs//,/ }; do
989 java-pkg_ensure-dep "${build_only}" "${pkg}"
990 done
805 991
806 if [[ -z "${classpath}" ]]; then 992 if [[ -z "${classpath}" ]]; then
807 classpath="${jars}" 993 classpath="${jars}"
808 else 994 else
809 classpath="${classpath}:${jars}" 995 classpath="${classpath}:${jars}"
810 fi 996 fi
811 997
812 # Only record jars that aren't build-only 998 # Only record jars that aren't build-only
813 if [[ -z "${build_only}" ]]; then 999 if [[ -z "${build_only}" ]]; then
814 oldifs="${IFS}"
815 IFS=","
816 for pkg in ${pkgs}; do 1000 for pkg in ${pkgs//,/ }; do
817 java-pkg_record-jar_ "${pkg}" 1001 java-pkg_record-jar_ "${pkg}"
818 done 1002 done
819 IFS="${oldifs}"
820 fi 1003 fi
821 1004
822 echo "${classpath}" 1005 echo "${classpath}"
823} 1006}
824 1007
834# @example 1017# @example
835# java-pkg_getjar xerces-2 xml-apis.jar 1018# java-pkg_getjar xerces-2 xml-apis.jar
836# @example-return 1019# @example-return
837# /usr/share/xerces-2/lib/xml-apis.jar 1020# /usr/share/xerces-2/lib/xml-apis.jar
838# 1021#
839# @param $1 - (optional) "--build-only" makes the jar not added into 1022# @param $opt
840# package.env DEPEND line. 1023# --build-only - makes the jar not added into package.env DEPEND line.
841# @param $1 - package to use 1024# @param $1 - package to use
842# @param $2 - jar to get 1025# @param $2 - jar to get
843# ------------------------------------------------------------------------------ 1026# ------------------------------------------------------------------------------
844java-pkg_getjar() { 1027java-pkg_getjar() {
845 debug-print-function ${FUNCNAME} $* 1028 debug-print-function ${FUNCNAME} $*
846 1029
847 local build_only="" 1030 local build_only=""
848 1031
1032 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
1033
1034 while [[ "${1}" == --* ]]; do
849 if [[ "${1}" = "--build-only" ]]; then 1035 if [[ "${1}" = "--build-only" ]]; then
850 build_only="true" 1036 build_only="build"
1037 else
1038 die "java-pkg_jar-from called with unknown parameter: ${1}"
1039 fi
851 shift 1040 shift
852 fi 1041 done
1042
1043 [[ ${#} -ne 2 ]] && die "${FUNCNAME} takes only two arguments besides --*"
853 1044
854 local pkg="${1}" target_jar="${2}" jar 1045 local pkg="${1}" target_jar="${2}" jar
855 [[ -z ${pkg} ]] && die "Must specify package to get a jar from" 1046 [[ -z ${pkg} ]] && die "Must specify package to get a jar from"
856 [[ -z ${target_jar} ]] && die "Must specify jar to get" 1047 [[ -z ${target_jar} ]] && die "Must specify jar to get"
857 1048
858 local error_msg="Could not find classpath for ${pkg}. Are you sure its installed?" 1049 local error_msg="Could not find classpath for ${pkg}. Are you sure its installed?"
859 local classpath 1050 local classpath
860 classpath=$(java-config --classpath=${pkg}) 1051 classpath=$(java-config --classpath=${pkg})
861 [[ $? != 0 ]] && die ${error_msg} 1052 [[ $? != 0 ]] && die ${error_msg}
1053
1054 java-pkg_ensure-dep "${build_only}" "${pkg}"
862 1055
863 for jar in ${classpath//:/ }; do 1056 for jar in ${classpath//:/ }; do
864 if [[ ! -f "${jar}" ]] ; then 1057 if [[ ! -f "${jar}" ]] ; then
865 die "Installation problem with jar ${jar} in ${pkg} - is it installed?" 1058 die "Installation problem with jar ${jar} in ${pkg} - is it installed?"
866 fi 1059 fi
873 fi 1066 fi
874 done 1067 done
875 1068
876 die "Could not find ${target_jar} in ${pkg}" 1069 die "Could not find ${target_jar} in ${pkg}"
877 return 1 1070 return 1
1071}
1072
1073# ------------------------------------------------------------------------------
1074# @ebuild-function java-pkg_register-dependency
1075#
1076# Registers runtime dependency on a package, list of packages, or a single jar
1077# from a package, into package.env DEPEND line. Can only be called in
1078# src_install phase.
1079# Intended for binary packages where you don't need to symlink the jars or get
1080# their classpath during build. As such, the dependencies only need to be
1081# specified in ebuild's RDEPEND, and should be omitted in DEPEND.
1082# Get the classpath provided by any number of packages.
1083#
1084# @param $1 - comma-separated list of packages, or a single package
1085# @param $2 - if param $1 is a single package, optionally specify the jar
1086# to depend on
1087#
1088# Example: Record the dependency on whole xerces-2 and xalan,
1089# java-pkg_register-dependency xerces-2,xalan
1090# Example: Record the dependency on ant.jar from ant-core
1091# java-pkg_register-dependency ant-core ant.jar
1092#
1093# Note: Passing both list of packages as the first parameter AND specifying the
1094# jar as the second is not allowed and will cause the function to die. We assume
1095# that there's more chance one passes such combination as a mistake, than that
1096# there are more packages providing identically named jar without class
1097# collisions.
1098# ------------------------------------------------------------------------------
1099java-pkg_register-dependency() {
1100 debug-print-function ${FUNCNAME} $*
1101
1102 java-pkg_check-phase install
1103
1104 [[ ${#} -gt 2 ]] && die "${FUNCNAME} takes at most two arguments"
1105
1106 local pkgs="${1}"
1107 local jar="${2}"
1108
1109 [[ -z "${pkgs}" ]] && die "${FUNCNAME} called with no package(s) specified"
1110
1111 if [[ -z "${jar}" ]]; then
1112 for pkg in ${pkgs//,/ }; do
1113 java-pkg_ensure-dep runtime "${pkg}"
1114 java-pkg_record-jar_ "${pkg}"
1115 done
1116 else
1117 [[ ${pkgs} == *,* ]] && \
1118 die "${FUNCNAME} called with both package list and jar name"
1119 java-pkg_ensure-dep runtime "${pkgs}"
1120 java-pkg_record-jar_ "${pkgs}" "${jar}"
1121 fi
1122
1123 java-pkg_do_write_
1124}
1125
1126# ------------------------------------------------------------------------------
1127# @ebuild-function java-pkg_register-environment-variable
1128#
1129# Register an arbitrary environment variable into package.env. The gjl launcher
1130# for this package or any package depending on this will export it into
1131# environement before executing java command.
1132# Must only be called in src_install phase.
1133#
1134# @param $1 - variable name
1135# @param $2 - variable value
1136# ------------------------------------------------------------------------------
1137JAVA_PKG_EXTRA_ENV="${T}/java-pkg-extra-env"
1138JAVA_PKG_EXTRA_ENV_VARS=""
1139java-pkg_register-environment-variable() {
1140 debug-print-function ${FUNCNAME} $*
1141
1142 java-pkg_check-phase install
1143
1144 [[ ${#} != 2 ]] && die "${FUNCNAME} takes two arguments"
1145
1146 echo "${1}=\"${2}\"" >> ${JAVA_PKG_EXTRA_ENV}
1147 JAVA_PKG_EXTRA_ENV_VARS="${JAVA_PKG_EXTRA_ENV_VARS} ${1}"
1148
1149 java-pkg_do_write_
878} 1150}
879 1151
880# This function reads stdin, and based on that input, figures out how to 1152# This function reads stdin, and based on that input, figures out how to
881# populate jars from the filesystem. 1153# populate jars from the filesystem.
882# Need to figure out a good way of making use of this, ie be able to use a 1154# Need to figure out a good way of making use of this, ie be able to use a
999# 1271#
1000# export DEPEND="${DEPEND} ${depstr}" 1272# export DEPEND="${DEPEND} ${depstr}"
1001# export RDEPEND="${RDEPEND} ${depstr}" 1273# export RDEPEND="${RDEPEND} ${depstr}"
1002#} 1274#}
1003 1275
1276# ------------------------------------------------------------------------------
1277# @ebuild-function java-pkg_find-normal-jars
1278#
1279# Find the files with suffix .jar file in the given directory or $WORKDIR
1280#
1281# @param $1 - The directory to search for jar files (default: ${WORKDIR})
1282# ------------------------------------------------------------------------------
1283java-pkg_find-normal-jars() {
1284 local dir=$1
1285 [[ "${dir}" ]] || dir="${WORKDIR}"
1286 local found
1287 for jar in $(find "${dir}" -name "*.jar" -type f); do
1288 echo "${jar}"
1289 found="true"
1290 done
1291 [[ "${found}" ]]
1292 return $?
1293}
1294
1295# ------------------------------------------------------------------------------
1296# @ebuild-function java-pkg_ensure-no-bundled-jars
1297#
1298# Try to locate bundled jar files in ${WORKDIR} and die if found.
1004# This should be used after S has been populated with symlinks to jars 1299# This function should be called after WORKDIR has been populated with symlink
1005# TODO document 1300# to system jar files or bundled jars removed.
1301# ------------------------------------------------------------------------------
1006java-pkg_ensure-no-bundled-jars() { 1302java-pkg_ensure-no-bundled-jars() {
1007 debug-print-function ${FUNCNAME} $* 1303 debug-print-function ${FUNCNAME} $*
1008 pushd ${WORKDIR} >/dev/null 2>/dev/null
1009 1304
1010 local bundled_jars=$(find . -name "*.jar" -type f) 1305 local bundled_jars=$(java-pkg_find-normal-jars)
1011 if [[ -n ${bundled_jars} ]]; then 1306 if [[ -n ${bundled_jars} ]]; then
1012 echo "Bundled jars found:" 1307 echo "Bundled jars found:"
1013 local jar 1308 local jar
1014 for jar in ${bundled_jars}; do 1309 for jar in ${bundled_jars}; do
1015 echo $(pwd)${jar/./} 1310 echo $(pwd)${jar/./}
1016 done 1311 done
1017 die "Bundled jars found!" 1312 die "Bundled jars found!"
1018
1019 fi 1313 fi
1020 popd >/dev/null 2>/dev/null
1021} 1314}
1022 1315
1023# ------------------------------------------------------------------------------ 1316# ------------------------------------------------------------------------------
1024# @internal-function java-pkg_ensure-vm-version-sufficient 1317# @internal-function java-pkg_ensure-vm-version-sufficient
1025# 1318#
1174# @ebuild-function java-pkg_get-target 1467# @ebuild-function java-pkg_get-target
1175# 1468#
1176# Determines what target version should be used, for passing to -target. 1469# Determines what target version should be used, for passing to -target.
1177# If you don't care about lower versions, you can set _WANT_TARGET to the 1470# If you don't care about lower versions, you can set _WANT_TARGET to the
1178# version of your JDK. 1471# version of your JDK.
1179# Remember doing this will mostly like cause things to break.
1180# Doesn't allow it to be lower then the one in depend.
1181# Doesn't allow it to be higher then the active vm.
1182# 1472#
1183# @return string - Either the lowest possible target, or JAVA_PKG_WANT_TARGET 1473# @return string - Either the lowest possible target, or JAVA_PKG_WANT_TARGET
1184# ------------------------------------------------------------------------------ 1474# ------------------------------------------------------------------------------
1185java-pkg_get-target() { 1475java-pkg_get-target() {
1186 local min=$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")
1187 if [[ -n "${JAVA_PKG_WANT_TARGET}" ]]; then
1188 local max="$(java-config --select-vm "${GENTOO_VM}" -g PROVIDES_VERSION)"
1189 if version_is_at_least "${min}" "${JAVA_PKG_WANT_TARGET}" && version_is_at_least "${JAVA_PKG_WANT_TARGET}" "${max}"; then
1190 echo ${JAVA_PKG_WANT_TARGET}
1191 else
1192 echo ${min}
1193 fi
1194 else
1195 echo ${min}
1196 fi
1197
1198 #echo ${JAVA_PKG_WANT_TARGET:-$(depend-java-query --get-lowest "${DEPEND}")} 1476 echo ${JAVA_PKG_WANT_TARGET:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1199} 1477}
1200 1478
1201java-pkg_get-javac() { 1479java-pkg_get-javac() {
1202 debug-print-function ${FUNCNAME} $* 1480 debug-print-function ${FUNCNAME} $*
1203 1481
1292 die "No GCJ support found!" 1570 die "No GCJ support found!"
1293 fi 1571 fi
1294} 1572}
1295 1573
1296java-pkg_ensure-test() { 1574java-pkg_ensure-test() {
1297 if hasq test ${FEATURES} && ! hasq -test ${FEATURES} && ! use test; then 1575 if hasq test ${FEATURES} && ! hasq -test ${FEATURES} \
1576 && hasq test ${IUSE} && ! use test;
1577 then
1298 eerror "You specified FEATURES=test, but USE=test is needed" 1578 eerror "You specified FEATURES=test, but USE=test is needed"
1299 eerror "to pull in the additional dependencies for testing" 1579 eerror "to pull in the additional dependencies for testing"
1300 die "Need USE=test enabled" 1580 die "Need USE=test enabled"
1301 fi 1581 fi
1302} 1582}
1303 1583
1304# ------------------------------------------------------------------------------ 1584# ------------------------------------------------------------------------------
1585# @ebuild-function java-pkg_register-ant-task
1586#
1587# Register this package as ant task, so that ant will load it when no specific
1588# ANT_TASKS are specified. Note that even without this registering, all packages
1589# specified in ANT_TASKS will be loaded. Mostly used by the actual ant tasks
1590# packages, but can be also used by other ebuilds that used to symlink their
1591# .jar into /usr/share/ant-core/lib to get autoloaded, for backwards
1592# compatibility.
1593#
1594# @param --version x.y Register only for ant version x.y (otherwise for any ant
1595# version). Used by the ant-* packages to prevent loading of mismatched
1596# ant-core ant tasks after core was updated, before the tasks are updated,
1597# without a need for blockers.
1598# @param $1 Name to register as. Defaults to JAVA_PKG_NAME ($PN[-$SLOT])
1599# ------------------------------------------------------------------------------
1600java-pkg_register-ant-task() {
1601 local TASKS_DIR="tasks"
1602
1603 # check for --version x.y parameters
1604 while [[ -n "${1}" && -n "${2}" ]]; do
1605 local var="${1#--}"
1606 local val="${2}"
1607 if [[ "${var}" == "version" ]]; then
1608 TASKS_DIR="tasks-${val}"
1609 else
1610 die "Unknown parameter passed to java-pkg_register-ant-tasks: ${1} ${2}"
1611 fi
1612 shift 2
1613 done
1614
1615 local TASK_NAME="${1:-${JAVA_PKG_NAME}}"
1616
1617 dodir /usr/share/ant/${TASKS_DIR}
1618 touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}"
1619}
1620
1621# ------------------------------------------------------------------------------
1622# @internal-function java-pkg_ant-tasks-from-deps
1623#
1624# Function to determine ANT_TASKS from DEPEND variable for backwards
1625# compatibility with ebuilds that don't set ANT_TASKS before calling eant() or
1626# WANT_ANT_TASKS before inheriting java-pkg-2. If the DEPEND string contains
1627# "dev-java/ant" or "dev-java/ant-tasks", then it returns "all", otherwise
1628# "none". It's not smart enough to cope with USE flag depends but that shouldn't
1629# be a problem, the worst it can do is activace all tasks when not needed.
1630# Note that this is called only with JAVA_PKG_STRICT=1, to find ebuilds with
1631# insufficient dependencies, otherwise all available tasks are used for
1632# backwards compatilbility.
1633#
1634# @return "all" or "none"
1635# ------------------------------------------------------------------------------
1636java-pkg_ant-tasks-from-deps() {
1637 local found_ant found_ant_tasks
1638
1639 for dep in ${DEPEND}
1640 do
1641 local ant="$(awk '/(dev-java\/ant)/ { if (match($1, "(dev-java/ant)((-[0-9])+|$)", m)) print m[1] }' <<< ${dep})"
1642 [[ "${ant}" == "dev-java/ant" ]] && found_ant=true
1643 [[ "${dep}" == *"ant-tasks"* ]] && found_ant_tasks=true
1644 done
1645
1646 if [[ -n "${found_ant}" || -n "${found_ant_tasks}" ]]; then
1647 java-pkg_announce-qa-violation --nodie "The ebuild DEPENDS on deprecated ant or ant-tasks"
1648 echo "all"
1649 else
1650 # ebuild doesn't set ANT_TASKS and doesn't depend on ant-tasks or ant
1651 # so we deactivate all tasks that may be installed
1652 echo "none"
1653 fi
1654}
1655
1656# ------------------------------------------------------------------------------
1657# @internal-function java-pkg_ant-tasks-depend
1658#
1659# Translates the WANT_ANT_TASKS variable into valid dependencies.
1660# ------------------------------------------------------------------------------
1661java-pkg_ant-tasks-depend() {
1662 debug-print-function ${FUNCNAME} ${WANT_ANT_TASKS}
1663
1664 if [[ -n "${WANT_ANT_TASKS}" ]]; then
1665 local DEP=""
1666 for i in ${WANT_ANT_TASKS}
1667 do
1668 if [[ ${i} != ant-* ]]; then
1669 echo "Invalid atom in WANT_ANT_TASKS: ${i}"
1670 return 1
1671 fi
1672 DEP="${DEP}dev-java/${i} "
1673 done
1674 echo ${DEP}
1675 return 0
1676 else
1677 return 0
1678 fi
1679}
1680
1681# ------------------------------------------------------------------------------
1682# @ebuild-function ejunit
1683#
1684# Junit wrapper function. Makes it easier to run the tests and checks for
1685# dev-java/junit in DEPEND. Launches the tests using junit.textui.TestRunner.
1686#
1687# Examples:
1688# ejunit -cp build/classes org.blinkenlights.jid3.test.AllTests
1689# ejunit org.blinkenlights.jid3.test.AllTests
1690#
1691# @param $1 - -cp or -classpath
1692# @param $2 - classpath, junit gets appended
1693# @param $@ - the rest of the parameters are passed to java
1694# ------------------------------------------------------------------------------
1695ejunit() {
1696 debug-print-function ${FUNCNAME} $*
1697
1698 local cp
1699 if [[ ${1} = -cp || ${1} = -classpath ]]; then
1700 cp=${2}:$(java-pkg_getjars --build-only junit)
1701 shift 2
1702 else
1703 cp=$(java-pkg_getjars --build-only junit):.
1704 fi
1705
1706 local runner=junit.textui.TestRunner
1707 debug-print "Calling: java -cp \"${cp}\" -Djava.awt.headless=true ${runner} ${@}"
1708 java -cp "${cp}" -Djava.awt.headless=true ${runner} "${@}" || die "Running junit failed"
1709}
1710
1711# ------------------------------------------------------------------------------
1305# @section-end helper 1712# @section-end helper
1306# ------------------------------------------------------------------------------ 1713# ------------------------------------------------------------------------------
1307 1714
1308# ------------------------------------------------------------------------------ 1715# ------------------------------------------------------------------------------
1309# @section-begin build 1716# @section-begin build
1315 1722
1316# ------------------------------------------------------------------------------ 1723# ------------------------------------------------------------------------------
1317# @ebuild-function eant 1724# @ebuild-function eant
1318# 1725#
1319# Ant wrapper function. Will use the appropriate compiler, based on user-defined 1726# Ant wrapper function. Will use the appropriate compiler, based on user-defined
1320# compiler. 1727# compiler. Will also set proper ANT_TASKS from the variable ANT_TASKS,
1321# 1728# variables:
1729# EANT_GENTOO_CLASSPATH - calls java-pkg_getjars for the value and adds to the
1730# gentoo.classpath property. Be sure to call
1731# java-ant_rewrite-classpath in src_unpack.
1732# *ANT_TASKS - used to determine ANT_TASKS before calling Ant.
1322# ------------------------------------------------------------------------------ 1733# ------------------------------------------------------------------------------
1323eant() { 1734eant() {
1324 debug-print-function ${FUNCNAME} $* 1735 debug-print-function ${FUNCNAME} $*
1325 1736
1326 # FIXME get this working 1737 if ! hasq java-ant-2 ${INHERITED}; then
1327# if is-java-strict && [[ ! ${DEPEND} =~ "dev-java/ant" ]]; then 1738 local msg="You should inherit java-ant-2 when using eant"
1328# java-pkg_announce-qa-violation \ 1739 java-pkg_announce-qa-violation "${msg}"
1329# "Using eant, but not depending on dev-java/ant or dev-java/ant-core"
1330# fi 1740 fi
1331 1741
1332 local antflags 1742 local antflags="-Dnoget=true -Dmaven.mode.offline=true"
1743
1333 java-pkg_init-compiler_ 1744 java-pkg_init-compiler_
1334 local compiler="${GENTOO_COMPILER}" 1745 local compiler="${GENTOO_COMPILER}"
1335 1746
1336 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}" 1747 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1337 1748
1339 if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then 1750 if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then
1340 die "ANT_BUILD_COMPILER undefined in ${compiler_env}" 1751 die "ANT_BUILD_COMPILER undefined in ${compiler_env}"
1341 fi 1752 fi
1342 1753
1343 if [[ ${compiler} != "javac" ]]; then 1754 if [[ ${compiler} != "javac" ]]; then
1344 antflags="-Dbuild.compiler=${build_compiler}" 1755 antflags="${antflags} -Dbuild.compiler=${build_compiler}"
1345 # Figure out any extra stuff to put on the classpath for compilers aside 1756 # Figure out any extra stuff to put on the classpath for compilers aside
1346 # from javac 1757 # from javac
1347 # ANT_BUILD_COMPILER_DEPS should be something that could be passed to 1758 # ANT_BUILD_COMPILER_DEPS should be something that could be passed to
1348 # java-config -p 1759 # java-config -p
1349 local build_compiler_deps="$(source ${JAVA_PKG_COMPILER_DIR}/${compiler} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER_DEPS})" 1760 local build_compiler_deps="$(source ${JAVA_PKG_COMPILER_DIR}/${compiler} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER_DEPS})"
1355 if is-java-strict; then 1766 if is-java-strict; then
1356 einfo "Disabling system classpath for ant" 1767 einfo "Disabling system classpath for ant"
1357 antflags="${antflags} -Dbuild.sysclasspath=ignore" 1768 antflags="${antflags} -Dbuild.sysclasspath=ignore"
1358 fi 1769 fi
1359 1770
1360 if [[ -n ${JAVA_PKG_DEBUG} ]]; then 1771 for arg in "${@}"; do
1361 antflags="${antflags} -debug" 1772 if [[ ${arg} = -lib ]]; then
1773 if is-java-strict; then
1774 eerror "You should not use the -lib argument to eant because it will fail"
1775 eerror "with JAVA_PKG_STRICT. Please use for example java-pkg_jar-from"
1776 eerror "or ant properties to make dependencies available."
1777 eerror "For ant tasks use WANT_ANT_TASKS or ANT_TASKS from."
1778 eerror "split ant (>=dev-java/ant-core-1.7)."
1779 die "eant -lib is deprecated/forbidden"
1780 else
1781 echo "eant -lib is deprecated. Turn JAVA_PKG_STRICT on for"
1782 echo "more info."
1783 fi
1784 fi
1785 done
1786
1787 if has_version ">=dev-java/ant-core-1.7.0"; then
1788 # default ANT_TASKS to WANT_ANT_TASKS, if ANT_TASKS is not set explicitly
1789 ANT_TASKS="${ANT_TASKS:-${WANT_ANT_TASKS}}"
1790
1791 # override ANT_TASKS with JAVA_PKG_FORCE_ANT_TASKS if it's set
1792 ANT_TASKS="${JAVA_PKG_FORCE_ANT_TASKS:-${ANT_TASKS}}"
1793
1794 if is-java-strict; then
1795 # if ant-tasks were not set by ebuild or forced, try to determine them from depends
1796 if [[ -z "${ANT_TASKS}" ]]; then
1797 ANT_TASKS="$(java-pkg_ant-tasks-from-deps)"
1798 fi
1799 else
1800 # if ant-tasks is not set by ebuild or forced, activate all of them
1801 ANT_TASKS="${ANT_TASKS:-all}"
1802 fi
1803
1804 # at this point, ANT_TASKS should be "all", "none" or explicit list
1805 if [[ "${ANT_TASKS}" == "all" ]]; then
1806 einfo "Using all available ANT_TASKS"
1807 elif [[ "${ANT_TASKS}" == "none" ]]; then
1808 einfo "Disabling all optional ANT_TASKS"
1809 else
1810 einfo "Using following ANT_TASKS: ${ANT_TASKS}"
1811 fi
1812
1813 export ANT_TASKS
1814 fi
1815
1816 [[ -n ${JAVA_PKG_DEBUG} ]] && antflags="${antflags} --execdebug -debug"
1817 [[ -n ${PORTAGE_QUIET} ]] && antflags="${antflags} -q"
1818
1819 local gcp="${EANT_GENTOO_CLASSPATH}"
1820 local getjarsarg=""
1821
1822 if [[ ${EBUILD_PHASE} = "test" ]]; then
1823 antflags="${antflags} -DJunit.present=true"
1824 [[ ${gcp} && ${ANT_TASKS} = *ant-junit* ]] && gcp="${gcp} junit"
1825 getjarsarg="--with-dependencies"
1826 fi
1827
1828 local cp
1829
1830 for atom in ${gcp}; do
1831 cp="${cp}:$(java-pkg_getjars ${getjarsarg} ${atom})"
1832 done
1833
1834 if [[ ${cp} ]]; then
1835 # It seems ant does not like single quotes around ${cp}
1836 antflags="${antflags} -Dgentoo.classpath=\"${cp#:}\""
1362 fi 1837 fi
1363 1838
1364 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}" 1839 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}"
1840 debug-print "Calling ant (GENTOO_VM: ${GENTOO_VM}): ${antflags} ${@}"
1365 ant ${antflags} "${@}" || die "eant failed" 1841 ant ${antflags} "${@}" || die "eant failed"
1366
1367} 1842}
1368 1843
1369# ------------------------------------------------------------------------------ 1844# ------------------------------------------------------------------------------
1370# @ebuild-function ejavac 1845# @ebuild-function ejavac
1371# 1846#
1440# ------------------------------------------------------------------------------ 1915# ------------------------------------------------------------------------------
1441use_doc() { 1916use_doc() {
1442 use doc && echo ${@:-javadoc} 1917 use doc && echo ${@:-javadoc}
1443} 1918}
1444 1919
1920
1445# ------------------------------------------------------------------------------ 1921# ------------------------------------------------------------------------------
1446# @section-end build 1922# @section-end build
1447# ------------------------------------------------------------------------------ 1923# ------------------------------------------------------------------------------
1448 1924
1449# ------------------------------------------------------------------------------ 1925# ------------------------------------------------------------------------------
1467# 1943#
1468# ----------------------------------------------------------------------------- 1944# -----------------------------------------------------------------------------
1469java-pkg_init() { 1945java-pkg_init() {
1470 unset JAVAC 1946 unset JAVAC
1471 unset JAVA_HOME 1947 unset JAVA_HOME
1948
1949 # People do all kinds of weird things.
1950 # http://forums.gentoo.org/viewtopic-p-3943166.html
1951 local silence="${SILENCE_JAVA_OPTIONS_WARNING}"
1952 local accept="${I_WANT_GLOBAL_JAVA_OPTIONS}"
1953 if [[ -n ${_JAVA_OPTIONS} && -z ${accept} && -z ${silence} ]]; then
1954 ewarn "_JAVA_OPTIONS changes what java -version outputs at least for"
1955 ewarn "sun-jdk vms and and as such break configure scripts that"
1956 ewarn "use it (for example app-office/openoffice) so we filter it out."
1957 ewarn "Use SILENCE_JAVA_OPTIONS_WARNING=true in the environment (use"
1958 ewarn "make.conf for example) to silence this warning or"
1959 ewarn "I_WANT_GLOBAL_JAVA_OPTIONS to not filter it."
1960 fi
1961
1962 if [[ -z ${accept} ]]; then
1963 unset _JAVA_OPTIONS
1964 # phase hooks make this run many times without this
1965 I_WANT_GLOBAL_JAVA_OPTIONS="true"
1966 fi
1967
1472 java-pkg_init_paths_ 1968 java-pkg_init_paths_
1473 java-pkg_switch-vm 1969 java-pkg_switch-vm
1474 PATH=${JAVA_HOME}/bin:${PATH} 1970 PATH=${JAVA_HOME}/bin:${PATH}
1475 1971
1476 # TODO we will probably want to set JAVAC and JAVACFLAGS 1972 # TODO we will probably want to set JAVAC and JAVACFLAGS
1481 # When users have crazy classpaths some packages can fail to compile. 1977 # When users have crazy classpaths some packages can fail to compile.
1482 # and everything should work with empty CLASSPATH. 1978 # and everything should work with empty CLASSPATH.
1483 # This also helps prevent unexpected dependencies on random things 1979 # This also helps prevent unexpected dependencies on random things
1484 # from the CLASSPATH. 1980 # from the CLASSPATH.
1485 unset CLASSPATH 1981 unset CLASSPATH
1982
1983 # Unset external ANT_ stuff
1984 unset ANT_TASKS
1985 unset ANT_OPTS
1486} 1986}
1487 1987
1488# ------------------------------------------------------------------------------ 1988# ------------------------------------------------------------------------------
1489# @function-internal java-pkg-init-compiler_ 1989# @function-internal java-pkg-init-compiler_
1490# 1990#
1666 >> ${JAVA_PKG_ENV} 2166 >> ${JAVA_PKG_ENV}
1667 2167
1668 2168
1669 echo "MERGE_VM=\"${GENTOO_VM}\"" >> "${JAVA_PKG_ENV}" 2169 echo "MERGE_VM=\"${GENTOO_VM}\"" >> "${JAVA_PKG_ENV}"
1670 [[ -n ${GENTOO_COMPILER} ]] && echo "MERGE_COMPILER=\"${GENTOO_COMPILER}\"" >> "${JAVA_PKG_ENV}" 2170 [[ -n ${GENTOO_COMPILER} ]] && echo "MERGE_COMPILER=\"${GENTOO_COMPILER}\"" >> "${JAVA_PKG_ENV}"
2171
2172 # extra env variables
2173 if [[ -n "${JAVA_PKG_EXTRA_ENV_VARS}" ]]; then
2174 cat "${JAVA_PKG_EXTRA_ENV}" >> "${JAVA_PKG_ENV}" || die
2175 # nested echo to remove leading/trailing spaces
2176 echo "ENV_VARS=\"$(echo ${JAVA_PKG_EXTRA_ENV_VARS})\"" \
2177 >> "${JAVA_PKG_ENV}" || die
2178 fi
1671 2179
1672 # Strip unnecessary leading and trailing colons 2180 # Strip unnecessary leading and trailing colons
1673 # TODO try to cleanup if possible 2181 # TODO try to cleanup if possible
1674 sed -e "s/=\":/=\"/" -e "s/:\"$/\"/" -i "${JAVA_PKG_ENV}" || die "Did you forget to call java_init ?" 2182 sed -e "s/=\":/=\"/" -e "s/:\"$/\"/" -i "${JAVA_PKG_ENV}" || die "Did you forget to call java_init ?"
1675 fi 2183 fi
1761# 2269#
1762# ------------------------------------------------------------------------------ 2270# ------------------------------------------------------------------------------
1763java-pkg_setup-vm() { 2271java-pkg_setup-vm() {
1764 debug-print-function ${FUNCNAME} $* 2272 debug-print-function ${FUNCNAME} $*
1765 2273
2274 export LANG="C" LC_ALL="C"
2275
1766 local vendor="$(java-pkg_get-vm-vendor)" 2276 local vendor="$(java-pkg_get-vm-vendor)"
1767 if [[ "${vendor}" == "sun" ]] && java-pkg_is-vm-version-ge "1.5" ; then 2277 if [[ "${vendor}" == "sun" ]] && java-pkg_is-vm-version-ge "1.5" ; then
1768 addpredict "/dev/random" 2278 addpredict "/dev/random"
1769 elif [[ "${vendor}" == "ibm" ]]; then 2279 elif [[ "${vendor}" == "ibm" ]]; then
1770 addpredict "/proc/self/maps" 2280 addpredict "/proc/self/maps"
1771 addpredict "/proc/cpuinfo" 2281 addpredict "/proc/cpuinfo"
1772 export LANG="C" LC_ALL="C"
1773 elif [[ "${vendor}" == "jrockit" ]]; then 2282 elif [[ "${vendor}" == "jrockit" ]]; then
1774 addpredict "/proc/cpuinfo" 2283 addpredict "/proc/cpuinfo"
1775 fi 2284 fi
1776} 2285}
1777 2286
1832# Switch VM if we're allowed to (controlled by JAVA_PKG_ALLOW_VM_CHANGE), and 2341# Switch VM if we're allowed to (controlled by JAVA_PKG_ALLOW_VM_CHANGE), and
1833# verify that the current VM is sufficient. 2342# verify that the current VM is sufficient.
1834# Setup the environment for the VM being used. 2343# Setup the environment for the VM being used.
1835# ------------------------------------------------------------------------------ 2344# ------------------------------------------------------------------------------
1836java-pkg_switch-vm() { 2345java-pkg_switch-vm() {
2346 debug-print-function ${FUNCNAME} $*
2347
1837 if java-pkg_needs-vm; then 2348 if java-pkg_needs-vm; then
1838 # Use the VM specified by JAVA_PKG_FORCE_VM 2349 # Use the VM specified by JAVA_PKG_FORCE_VM
1839 if [[ -n ${JAVA_PKG_FORCE_VM} ]]; then 2350 if [[ -n "${JAVA_PKG_FORCE_VM}" ]]; then
1840 # If you're forcing the VM, I hope you know what your doing... 2351 # If you're forcing the VM, I hope you know what your doing...
2352 debug-print "JAVA_PKG_FORCE_VM used: ${JAVA_PKG_FORCE_VM}"
1841 export GENTOO_VM="${JAVA_PKG_FORCE_VM}" 2353 export GENTOO_VM="${JAVA_PKG_FORCE_VM}"
1842 # if we're allowed to switch the vm... 2354 # if we're allowed to switch the vm...
1843 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then 2355 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then
1844 debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}} VNEED: ${JAVA_PKG_VNEED}" 2356 debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}} VNEED: ${JAVA_PKG_VNEED}"
1845 if [[ -n ${JAVA_PKG_VNEED} ]]; then 2357 if [[ -n ${JAVA_PKG_VNEED} ]]; then
1925 einfo "Classes" 2437 einfo "Classes"
1926 find "${S}" -type f -name '*.class' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR}," 2438 find "${S}" -type f -name '*.class' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
1927 fi 2439 fi
1928} 2440}
1929 2441
1930# TODO document 2442# ------------------------------------------------------------------------------
2443# @internal-function java-pkg_verify-classes
2444#
1931# Verify that the classes were compiled for the right source / target 2445# Verify that the classes were compiled for the right source / target. Dies if
2446# not.
2447# @param $1 (optional) - the file to check, otherwise checks whole ${D}
2448# ------------------------------------------------------------------------------
1932java-pkg_verify-classes() { 2449java-pkg_verify-classes() {
1933 ebegin "Verifying java class versions"
1934 #$(find ${D} -type f -name '*.jar' -o -name '*.class') 2450 #$(find ${D} -type f -name '*.jar' -o -name '*.class')
1935 class-version-verify.py -t $(java-pkg_get-target) -r ${D} 2451 local target=$(java-pkg_get-target)
2452 local result
2453 local log="${T}/class-version-verify.log"
2454 if [[ -n "${1}" ]]; then
2455 class-version-verify.py -v -t ${target} "${1}" > "${log}"
1936 result=$? 2456 result=$?
1937 eend ${result}
1938 if [[ ${result} == 0 ]]; then
1939 einfo "All good"
1940 else 2457 else
1941 ewarn "Possible problem" 2458 ebegin "Verifying java class versions (target: ${target})"
1942 die "Bad class files found" 2459 class-version-verify.py -v -t ${target} -r "${D}" > "${log}"
2460 result=$?
2461 eend ${result}
2462 fi
2463 [[ -n ${JAVA_PKG_DEBUG} ]] && cat "${log}"
2464 if [[ ${result} != 0 ]]; then
2465 eerror "Incorrect bytecode version found"
2466 [[ -n "${1}" ]] && eerror "in file: ${1}"
2467 eerror "See ${log} for more details."
2468 die "Incorrect bytecode found"
2469 fi
2470}
2471
2472# ----------------------------------------------------------------------------
2473# @internal-function java-pkg_ensure-dep
2474# Check that a package being used in jarfrom, getjars and getjar is contained
2475# within DEPEND or RDEPEND.
2476# @param $1 - empty - check both vars; "runtime" or "build" - check only
2477# RDEPEND, resp. DEPEND
2478# @param $2 - Package name and slot.
2479java-pkg_ensure-dep() {
2480 debug-print-function ${FUNCNAME} $*
2481
2482 local limit_to="${1}"
2483 local target_pkg="${2}"
2484 local dev_error=""
2485
2486 local stripped_pkg=$(echo "${target_pkg}" | sed \
2487 's/-[0-9]*\(\.[0-9]\)*$//')
2488
2489 if [[ ${limit_to} != runtime && ! ( "${DEPEND}" =~ "$stripped_pkg" ) ]]; then
2490 dev_error="The ebuild is attempting to use ${target_pkg} that is not"
2491 dev_error="${dev_error} declared in DEPEND."
2492 if is-java-strict; then
2493 die "${dev_error}"
2494 elif [[ ${BASH_SUBSHELL} = 0 ]]; then
2495 eerror "${dev_error}"
2496 elog "Because you have this package installed the package will"
2497 elog "build without problems, but please report this to"
2498 elog "http://bugs.gentoo.org"
2499 fi
2500 fi
2501
2502 if [[ ${limit_to} != build && ! ( ${RDEPEND} =~ "${stripped_pkg}" ) ]]; then
2503 dev_error="The ebuild is attempting to use ${target_pkg},"
2504 dev_error="${dev_error} without specifying --build-only, that is not declared in RDEPEND."
2505 if is-java-strict; then
2506 die "${dev_error}"
2507 elif [[ ${BASH_SUBSHELL} = 0 ]]; then
2508 eerror "${dev_error}"
2509 elog "The package will build without problems, but may fail to run"
2510 elog "if you don't have ${target_pkg} installed, so please report"
2511 elog "this to http://bugs.gentoo.org"
2512 fi
1943 fi 2513 fi
1944} 2514}
1945 2515
1946# ------------------------------------------------------------------------------ 2516# ------------------------------------------------------------------------------
1947# @section-end internal 2517# @section-end internal
1948# ------------------------------------------------------------------------------ 2518# ------------------------------------------------------------------------------
1949 2519
1950java-pkg_check-phase() { 2520java-pkg_check-phase() {
1951 local phase=${1} 2521 local phase=${1}
1952 local funcname=${2} 2522 local funcname=${FUNCNAME[1]}
1953 if is-java-strict && [[ ${EBUILD_PHASE} != ${phase} ]]; then 2523 if [[ ${EBUILD_PHASE} != ${phase} ]]; then
1954 java-pkg_announce-qa-violation \
1955 "${funcname} used outside of src_${phase}" 2524 local msg="${funcname} used outside of src_${phase}"
2525 java-pkg_announce-qa-violation "${msg}"
1956 fi 2526 fi
1957} 2527}
1958 2528
1959java-pkg_check-versioned-jar() { 2529java-pkg_check-versioned-jar() {
1960 local jar=${1} 2530 local jar=${1}
1969 java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE" 2539 java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE"
1970 fi 2540 fi
1971} 2541}
1972 2542
1973java-pkg_announce-qa-violation() { 2543java-pkg_announce-qa-violation() {
1974 if is-java-strict; then 2544 local nodie
2545 if [[ ${1} == "--nodie" ]]; then
2546 nodie="true"
2547 shift
2548 fi
1975 echo "Java QA Notice: $@" >&2 2549 echo "Java QA Notice: $@" >&2
1976 increment-qa-violations 2550 increment-qa-violations
1977 fi 2551 [[ -z "${nodie}" ]] && is-java-strict && die "${@}"
1978} 2552}
1979 2553
1980increment-qa-violations() { 2554increment-qa-violations() {
1981 let "JAVA_PKG_QA_VIOLATIONS+=1" 2555 let "JAVA_PKG_QA_VIOLATIONS+=1"
1982 export JAVA_PKG_QA_VIOLATIONS 2556 export JAVA_PKG_QA_VIOLATIONS

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

  ViewVC Help
Powered by ViewVC 1.1.20