/[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.129 - (show annotations) (download)
Sun Jun 7 08:22:42 2009 UTC (5 years, 5 months ago) by ali_bush
Branch: MAIN
Changes since 1.128: +49 -18 lines
Add build-only jar recording support.

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

  ViewVC Help
Powered by ViewVC 1.1.20