/[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.92 - (show annotations) (download)
Sun Aug 5 08:17:05 2007 UTC (7 years, 3 months ago) by betelgeuse
Branch: MAIN
Changes since 1.91: +38 -12 lines
Remove eclass hooks to resolve bug #163262.

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

  ViewVC Help
Powered by ViewVC 1.1.20