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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.168 - (show annotations) (download)
Fri Jul 31 07:56:17 2015 UTC (3 years, 2 months ago) by monsieurp
Branch: MAIN
Changes since 1.167: +20 -10 lines
Document JAVA_RM_FILES variable. Also, fix documentation and correct typos in java-pkg_rm_files.

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

  ViewVC Help
Powered by ViewVC 1.1.20