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

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

  ViewVC Help
Powered by ViewVC 1.1.20