/[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.128 - (show annotations) (download)
Tue Jun 2 07:02:01 2009 UTC (5 years, 4 months ago) by ali_bush
Branch: MAIN
Changes since 1.127: +3 -85 lines
Remove obsolete JAVA_PKG_VNEED 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.127 2009/05/19 21:23:32 caster 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
878 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
879
880 while [[ "${1}" == --* ]]; do
881 if [[ "${1}" = "--build-only" ]]; then
882 build_only="build"
883 elif [[ "${1}" = "--with-dependencies" ]]; then
884 deep="--with-dependencies"
885 elif [[ "${1}" = "--virtual" ]]; then
886 virtual="true"
887 elif [[ "${1}" = "--into" ]]; then
888 destdir="${2}"
889 shift
890 else
891 die "java-pkg_jar-from called with unknown parameter: ${1}"
892 fi
893 shift
894 done
895
896 local target_pkg="${1}" target_jar="${2}" destjar="${3}"
897
898 [[ -z ${target_pkg} ]] && die "Must specify a package"
899
900 if [[ "${EAPI}" == "1" ]]; then
901 target_pkg="${target_pkg//:/-}"
902 fi
903
904 # default destjar to the target jar
905 [[ -z "${destjar}" ]] && destjar="${target_jar}"
906
907 local error_msg="There was a problem getting the classpath for ${target_pkg}."
908 local classpath
909 classpath="$(java-config ${deep} --classpath=${target_pkg})"
910 [[ $? != 0 ]] && die ${error_msg}
911
912 # When we have commas this functions is called to bring jars from multiple
913 # packages. This affects recording of dependencencies performed later
914 # which expects one package only, so we do it here.
915 if [[ ${target_pkg} = *,* ]]; then
916 for pkg in ${target_pkg//,/ }; do
917 java-pkg_ensure-dep "${build_only}" "${pkg}"
918 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${pkg}"
919 done
920 # setting this disables further record-jar_ calls later
921 build_only="build"
922 else
923 java-pkg_ensure-dep "${build_only}" "${target_pkg}"
924 fi
925
926 # Record the entire virtual as a dependency so that
927 # no jars are missed.
928 if [[ -z "${build_only}" && -n "${virtual}" ]]; then
929 java-pkg_record-jar_ "${target_pkg}"
930 # setting this disables further record-jars_ calls later
931 build_only="build"
932 fi
933
934 pushd ${destdir} > /dev/null \
935 || die "failed to change directory to ${destdir}"
936
937 local jar
938 for jar in ${classpath//:/ }; do
939 local jar_name=$(basename "${jar}")
940 if [[ ! -f "${jar}" ]] ; then
941 debug-print "${jar} from ${target_pkg} does not exist"
942 die "Installation problems with jars in ${target_pkg} - is it installed?"
943 fi
944 # If no specific target jar was indicated, link it
945 if [[ -z "${target_jar}" ]] ; then
946 [[ -f "${target_jar}" ]] && rm "${target_jar}"
947 ln -snf "${jar}" \
948 || die "Failed to make symlink from ${jar} to ${jar_name}"
949 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${target_pkg}" "${jar}"
950 # otherwise, if the current jar is the target jar, link it
951 elif [[ "${jar_name}" == "${target_jar}" ]] ; then
952 [[ -f "${destjar}" ]] && rm "${destjar}"
953 ln -snf "${jar}" "${destjar}" \
954 || die "Failed to make symlink from ${jar} to ${destjar}"
955 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${target_pkg}" "${jar}"
956 popd > /dev/null
957 return 0
958 fi
959 done
960 popd > /dev/null
961 # if no target was specified, we're ok
962 if [[ -z "${target_jar}" ]] ; then
963 return 0
964 # otherwise, die bitterly
965 else
966 die "Failed to find ${target_jar:-jar} in ${target_pkg}"
967 fi
968 }
969
970 # ------------------------------------------------------------------------------
971 # @ebuild-function java-pkg_jarfrom
972 #
973 # See java-pkg_jar-from
974 # ------------------------------------------------------------------------------
975 java-pkg_jarfrom() {
976 java-pkg_jar-from "$@"
977 }
978
979 # ------------------------------------------------------------------------------
980 # @ebuild-function java-pkg_getjars
981 #
982 # Get the classpath provided by any number of packages
983 # Among other things, this can be passed to 'javac -classpath' or 'ant -lib'.
984 # The providing packages are recorded as dependencies into package.env DEPEND
985 # line, unless "--build-only" is passed as the very first argument, for jars
986 # that have to be present only at build time and are not needed on runtime
987 # (junit testing etc).
988 #
989 # Example: Get the classpath for xerces-2 and xalan,
990 # java-pkg_getjars xerces-2,xalan
991 # Example Return:
992 # /usr/share/xerces-2/lib/xml-apis.jar:/usr/share/xerces-2/lib/xmlParserAPIs.jar:/usr/share/xalan/lib/xalan.jar
993 #
994 # @param $opt
995 # --build-only - makes the jar(s) not added into package.env DEPEND line.
996 # (assumed automatically when called inside src_test)
997 # --with-dependencies - get jars also from requested package's dependencies
998 # transitively.
999 # @param $1 - list of packages to get jars from
1000 # (passed to java-config --classpath)
1001 # ------------------------------------------------------------------------------
1002 java-pkg_getjars() {
1003 debug-print-function ${FUNCNAME} $*
1004
1005 local build_only=""
1006 local deep=""
1007
1008 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
1009
1010 while [[ "${1}" == --* ]]; do
1011 if [[ "${1}" = "--build-only" ]]; then
1012 build_only="build"
1013 elif [[ "${1}" = "--with-dependencies" ]]; then
1014 deep="--with-dependencies"
1015 else
1016 die "java-pkg_jar-from called with unknown parameter: ${1}"
1017 fi
1018 shift
1019 done
1020
1021 [[ ${#} -ne 1 ]] && die "${FUNCNAME} takes only one argument besides --*"
1022
1023
1024 local pkgs="${1}"
1025
1026 if [[ "${EAPI}" == "1" ]]; then
1027 pkgs="${pkgs//:/-}"
1028 fi
1029
1030 jars="$(java-config ${deep} --classpath=${pkgs})"
1031 [[ $? != 0 ]] && die "java-config --classpath=${pkgs} failed"
1032 debug-print "${pkgs}:${jars}"
1033
1034 for pkg in ${pkgs//,/ }; do
1035 java-pkg_ensure-dep "${build_only}" "${pkg}"
1036 done
1037
1038 # Only record jars that aren't build-only
1039 if [[ -z "${build_only}" ]]; then
1040 for pkg in ${pkgs//,/ }; do
1041 java-pkg_record-jar_ "${pkg}"
1042 done
1043 fi
1044
1045 echo "${jars}"
1046 }
1047
1048 # ------------------------------------------------------------------------------
1049 # @ebuild-function java-pkg_getjar
1050 #
1051 # Get the filename of a single jar from a package
1052 # The providing package is recorded as runtime dependency into package.env
1053 # DEPEND line, unless "--build-only" is passed as the very first argument, for
1054 # jars that have to be present only at build time and are not needed on runtime
1055 # (junit testing etc).
1056 #
1057 # @example
1058 # java-pkg_getjar xerces-2 xml-apis.jar
1059 # @example-return
1060 # /usr/share/xerces-2/lib/xml-apis.jar
1061 #
1062 # @param $opt
1063 # --build-only - makes the jar not added into package.env DEPEND line.
1064 # --virtual - Packages passed to this function are to be handled as virtuals
1065 # and will not have individual jar dependencies recorded.
1066 # @param $1 - package to use
1067 # @param $2 - jar to get
1068 # ------------------------------------------------------------------------------
1069 java-pkg_getjar() {
1070 debug-print-function ${FUNCNAME} $*
1071
1072 local build_only=""
1073 local virtual=""
1074
1075 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="build"
1076
1077 while [[ "${1}" == --* ]]; do
1078 if [[ "${1}" = "--build-only" ]]; then
1079 build_only="build"
1080 elif [[ "${1}" == "--virtual" ]]; then
1081 virtual="true"
1082 else
1083 die "java-pkg_getjar called with unknown parameter: ${1}"
1084 fi
1085 shift
1086 done
1087
1088 [[ ${#} -ne 2 ]] && die "${FUNCNAME} takes only two arguments besides --*"
1089
1090 local pkg="${1}" target_jar="${2}" jar
1091
1092 if [[ "${EAPI}" == "1" ]]; then
1093 pkg="${pkg//:/-}"
1094 fi
1095
1096 [[ -z ${pkg} ]] && die "Must specify package to get a jar from"
1097 [[ -z ${target_jar} ]] && die "Must specify jar to get"
1098
1099 local error_msg="Could not find classpath for ${pkg}. Are you sure its installed?"
1100 local classpath
1101 classpath=$(java-config --classpath=${pkg})
1102 [[ $? != 0 ]] && die ${error_msg}
1103
1104 java-pkg_ensure-dep "${build_only}" "${pkg}"
1105
1106 # Record the package(Virtual) as a dependency and then set build_only
1107 # So that individual jars are not recorded.
1108 if [[ -n "${virtual}" ]]; then
1109 java-pkg_record-jar_ "${pkg}"
1110 build_only="true"
1111 fi
1112
1113 for jar in ${classpath//:/ }; do
1114 if [[ ! -f "${jar}" ]] ; then
1115 die "Installation problem with jar ${jar} in ${pkg} - is it installed?"
1116 fi
1117
1118 if [[ "$(basename ${jar})" == "${target_jar}" ]] ; then
1119 # Only record jars that aren't build-only
1120 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${pkg}" "${jar}"
1121 echo "${jar}"
1122 return 0
1123 fi
1124 done
1125
1126 die "Could not find ${target_jar} in ${pkg}"
1127 return 1
1128 }
1129
1130 # ------------------------------------------------------------------------------
1131 # @ebuild-function java-pkg_register-dependency
1132 #
1133 # Registers runtime dependency on a package, list of packages, or a single jar
1134 # from a package, into package.env DEPEND line. Can only be called in
1135 # src_install phase.
1136 # Intended for binary packages where you don't need to symlink the jars or get
1137 # their classpath during build. As such, the dependencies only need to be
1138 # specified in ebuild's RDEPEND, and should be omitted in DEPEND.
1139 #
1140 # @param $1 - comma-separated list of packages, or a single package
1141 # @param $2 - if param $1 is a single package, optionally specify the jar
1142 # to depend on
1143 #
1144 # Example: Record the dependency on whole xerces-2 and xalan,
1145 # java-pkg_register-dependency xerces-2,xalan
1146 # Example: Record the dependency on ant.jar from ant-core
1147 # java-pkg_register-dependency ant-core ant.jar
1148 #
1149 # Note: Passing both list of packages as the first parameter AND specifying the
1150 # jar as the second is not allowed and will cause the function to die. We assume
1151 # that there's more chance one passes such combination as a mistake, than that
1152 # there are more packages providing identically named jar without class
1153 # collisions.
1154 # ------------------------------------------------------------------------------
1155 java-pkg_register-dependency() {
1156 debug-print-function ${FUNCNAME} $*
1157
1158 java-pkg_check-phase install
1159
1160 [[ ${#} -gt 2 ]] && die "${FUNCNAME} takes at most two arguments"
1161
1162 local pkgs="${1}"
1163 local jar="${2}"
1164
1165 [[ -z "${pkgs}" ]] && die "${FUNCNAME} called with no package(s) specified"
1166
1167 if [[ "${EAPI}" == "1" ]]; then
1168 pkgs="${pkgs//:/-}"
1169 fi
1170
1171 if [[ -z "${jar}" ]]; then
1172 for pkg in ${pkgs//,/ }; do
1173 java-pkg_ensure-dep runtime "${pkg}"
1174 java-pkg_record-jar_ "${pkg}"
1175 done
1176 else
1177 [[ ${pkgs} == *,* ]] && \
1178 die "${FUNCNAME} called with both package list and jar name"
1179 java-pkg_ensure-dep runtime "${pkgs}"
1180 java-pkg_record-jar_ "${pkgs}" "${jar}"
1181 fi
1182
1183 java-pkg_do_write_
1184 }
1185
1186 # ------------------------------------------------------------------------------
1187 # @ebuild-function java-pkg_register-optional-dependency
1188 #
1189 # Registers optional runtime dependency on a package, list of packages, or a
1190 # single jar from a package, into package.env OPTIONAL_DEPEND line. Can only be
1191 # called in src_install phase.
1192 # Intended for packages that can use other packages when those are in classpath.
1193 # Will be put on classpath by launcher if they are installed. Typical case is
1194 # JDBC implementations for various databases. It's better than having USE flag
1195 # for each implementation triggering hard dependency.
1196 #
1197 # @param $1 - comma-separated list of packages, or a single package
1198 # @param $2 - if param $1 is a single package, optionally specify the jar
1199 # to depend on
1200 #
1201 # Example: Record the optional dependency on some jdbc providers
1202 # java-pkg_register-optional-dependency jdbc-jaybird,jtds-1.2,jdbc-mysql
1203 #
1204 # Note: Passing both list of packages as the first parameter AND specifying the
1205 # jar as the second is not allowed and will cause the function to die. We assume
1206 # that there's more chance one passes such combination as a mistake, than that
1207 # there are more packages providing identically named jar without class
1208 # collisions.
1209 # ------------------------------------------------------------------------------
1210 java-pkg_register-optional-dependency() {
1211 debug-print-function ${FUNCNAME} $*
1212
1213 java-pkg_check-phase install
1214
1215 [[ ${#} -gt 2 ]] && die "${FUNCNAME} takes at most two arguments"
1216
1217 local pkgs="${1}"
1218 local jar="${2}"
1219
1220 [[ -z "${pkgs}" ]] && die "${FUNCNAME} called with no package(s) specified"
1221
1222 if [[ "${EAPI}" == "1" ]]; then
1223 pkgs="${pkgs//:/-}"
1224 fi
1225
1226 if [[ -z "${jar}" ]]; then
1227 for pkg in ${pkgs//,/ }; do
1228 java-pkg_record-jar_ --optional "${pkg}"
1229 done
1230 else
1231 [[ ${pkgs} == *,* ]] && \
1232 die "${FUNCNAME} called with both package list and jar name"
1233 java-pkg_record-jar_ --optional "${pkgs}" "${jar}"
1234 fi
1235
1236 java-pkg_do_write_
1237 }
1238
1239 # ------------------------------------------------------------------------------
1240 # @ebuild-function java-pkg_register-environment-variable
1241 #
1242 # Register an arbitrary environment variable into package.env. The gjl launcher
1243 # for this package or any package depending on this will export it into
1244 # environement before executing java command.
1245 # Must only be called in src_install phase.
1246 #
1247 # @param $1 - variable name
1248 # @param $2 - variable value
1249 # ------------------------------------------------------------------------------
1250 JAVA_PKG_EXTRA_ENV="${T}/java-pkg-extra-env"
1251 JAVA_PKG_EXTRA_ENV_VARS=""
1252 java-pkg_register-environment-variable() {
1253 debug-print-function ${FUNCNAME} $*
1254
1255 java-pkg_check-phase install
1256
1257 [[ ${#} != 2 ]] && die "${FUNCNAME} takes two arguments"
1258
1259 echo "${1}=\"${2}\"" >> ${JAVA_PKG_EXTRA_ENV}
1260 JAVA_PKG_EXTRA_ENV_VARS="${JAVA_PKG_EXTRA_ENV_VARS} ${1}"
1261
1262 java-pkg_do_write_
1263 }
1264
1265 # This function reads stdin, and based on that input, figures out how to
1266 # populate jars from the filesystem.
1267 # Need to figure out a good way of making use of this, ie be able to use a
1268 # string that was built instead of stdin
1269 # NOTE: this isn't quite ready for primetime.
1270 #java-pkg_populate-jars() {
1271 # local line
1272 #
1273 # read line
1274 # while [[ -n "${line}" ]]; do
1275 # # Ignore comments
1276 # [[ ${line%%#*} == "" ]] && continue
1277 #
1278 # # get rid of any spaces
1279 # line="${line// /}"
1280 #
1281 # # format: path=jarinfo
1282 # local path=${line%%=*}
1283 # local jarinfo=${line##*=}
1284 #
1285 # # format: jar@package
1286 # local jar=${jarinfo%%@*}.jar
1287 # local package=${jarinfo##*@}
1288 # if [[ -n ${replace_only} ]]; then
1289 # [[ ! -f $path ]] && die "No jar exists at ${path}"
1290 # fi
1291 # if [[ -n ${create_parent} ]]; then
1292 # local parent=$(dirname ${path})
1293 # mkdir -p "${parent}"
1294 # fi
1295 # java-pkg_jar-from "${package}" "${jar}" "${path}"
1296 #
1297 # read line
1298 # done
1299 #}
1300
1301 # ------------------------------------------------------------------------------
1302 # @section-end query
1303 # ------------------------------------------------------------------------------
1304
1305 # ------------------------------------------------------------------------------
1306 # @section-begin helper
1307 # @section-summary Helper functions
1308 #
1309 # Various other functions to use from an ebuild
1310 # ------------------------------------------------------------------------------
1311
1312 # ------------------------------------------------------------------------------
1313 # @ebuild-function java-pkg_find-normal-jars
1314 #
1315 # Find the files with suffix .jar file in the given directory or $WORKDIR
1316 #
1317 # @param $1 - The directory to search for jar files (default: ${WORKDIR})
1318 # ------------------------------------------------------------------------------
1319 java-pkg_find-normal-jars() {
1320 local dir=$1
1321 [[ "${dir}" ]] || dir="${WORKDIR}"
1322 local found
1323 for jar in $(find "${dir}" -name "*.jar" -type f); do
1324 echo "${jar}"
1325 found="true"
1326 done
1327 [[ "${found}" ]]
1328 return $?
1329 }
1330
1331 # ------------------------------------------------------------------------------
1332 # @ebuild-function java-pkg_ensure-no-bundled-jars
1333 #
1334 # Try to locate bundled jar files in ${WORKDIR} and die if found.
1335 # This function should be called after WORKDIR has been populated with symlink
1336 # to system jar files or bundled jars removed.
1337 # ------------------------------------------------------------------------------
1338 java-pkg_ensure-no-bundled-jars() {
1339 debug-print-function ${FUNCNAME} $*
1340
1341 local bundled_jars=$(java-pkg_find-normal-jars)
1342 if [[ -n ${bundled_jars} ]]; then
1343 echo "Bundled jars found:"
1344 local jar
1345 for jar in ${bundled_jars}; do
1346 echo $(pwd)${jar/./}
1347 done
1348 die "Bundled jars found!"
1349 fi
1350 }
1351
1352 # ------------------------------------------------------------------------------
1353 # @internal-function java-pkg_ensure-vm-version-sufficient
1354 #
1355 # Checks if we have a sufficient VM and dies if we don't.
1356 #
1357 # ------------------------------------------------------------------------------
1358 java-pkg_ensure-vm-version-sufficient() {
1359 debug-print-function ${FUNCNAME} $*
1360
1361 if ! java-pkg_is-vm-version-sufficient; then
1362 debug-print "VM is not suffient"
1363 eerror "Current Java VM cannot build this package"
1364 einfo "Please use java-config -S to set the correct one"
1365 die "Active Java VM cannot build this package"
1366 fi
1367 }
1368
1369 # ------------------------------------------------------------------------------
1370 # @internal-function java-pkg_is-vm-version-sufficient
1371 #
1372 # @return zero - VM is sufficient
1373 # @return non-zero - VM is not sufficient
1374 # ------------------------------------------------------------------------------
1375 java-pkg_is-vm-version-sufficient() {
1376 debug-print-function ${FUNCNAME} $*
1377
1378 depend-java-query --is-sufficient "${DEPEND}" > /dev/null
1379 return $?
1380 }
1381
1382 # ------------------------------------------------------------------------------
1383 # @internal-function java-pkg_ensure-vm-version-eq
1384 #
1385 # Die if the current VM is not equal to the argument passed.
1386 #
1387 # @param $@ - Desired VM version to ensure
1388 # ------------------------------------------------------------------------------
1389 java-pkg_ensure-vm-version-eq() {
1390 debug-print-function ${FUNCNAME} $*
1391
1392 if ! java-pkg_is-vm-version-eq $@ ; then
1393 debug-print "VM is not suffient"
1394 eerror "This package requires a Java VM version = $@"
1395 einfo "Please use java-config -S to set the correct one"
1396 die "Active Java VM too old"
1397 fi
1398 }
1399
1400 # ------------------------------------------------------------------------------
1401 # @internal-function java-pkg_is-vm-version-eq
1402 #
1403 # @param $@ - VM version to compare current VM to
1404 # @return zero - VM versions are equal
1405 # @return non-zero - VM version are not equal
1406 # ------------------------------------------------------------------------------
1407 java-pkg_is-vm-version-eq() {
1408 debug-print-function ${FUNCNAME} $*
1409
1410 local needed_version="$@"
1411
1412 [[ -z "${needed_version}" ]] && die "need an argument"
1413
1414 local vm_version="$(java-pkg_get-vm-version)"
1415
1416 vm_version="$(get_version_component_range 1-2 "${vm_version}")"
1417 needed_version="$(get_version_component_range 1-2 "${needed_version}")"
1418
1419 if [[ -z "${vm_version}" ]]; then
1420 debug-print "Could not get JDK version from DEPEND"
1421 return 1
1422 else
1423 if [[ "${vm_version}" == "${needed_version}" ]]; then
1424 debug-print "Detected a JDK(${vm_version}) = ${needed_version}"
1425 return 0
1426 else
1427 debug-print "Detected a JDK(${vm_version}) != ${needed_version}"
1428 return 1
1429 fi
1430 fi
1431 }
1432
1433 # ------------------------------------------------------------------------------
1434 # @internal-function java-pkg_ensure-vm-version-ge
1435 #
1436 # Die if the current VM is not greater than the desired version
1437 #
1438 # @param $@ - VM version to compare current to
1439 # ------------------------------------------------------------------------------
1440 java-pkg_ensure-vm-version-ge() {
1441 debug-print-function ${FUNCNAME} $*
1442
1443 if ! java-pkg_is-vm-version-ge "$@" ; then
1444 debug-print "vm is not suffient"
1445 eerror "This package requires a Java VM version >= $@"
1446 einfo "Please use java-config -S to set the correct one"
1447 die "Active Java VM too old"
1448 fi
1449 }
1450
1451 # ------------------------------------------------------------------------------
1452 # @internal-function java-pkg_is-vm-version-ge
1453 #
1454 # @param $@ - VM version to compare current VM to
1455 # @return zero - current VM version is greater than checked version
1456 # @return non-zero - current VM version is not greater than checked version
1457 # ------------------------------------------------------------------------------
1458 java-pkg_is-vm-version-ge() {
1459 debug-print-function ${FUNCNAME} $*
1460
1461 local needed_version=$@
1462 local vm_version=$(java-pkg_get-vm-version)
1463 if [[ -z "${vm_version}" ]]; then
1464 debug-print "Could not get JDK version from DEPEND"
1465 return 1
1466 else
1467 if version_is_at_least "${needed_version}" "${vm_version}"; then
1468 debug-print "Detected a JDK(${vm_version}) >= ${needed_version}"
1469 return 0
1470 else
1471 debug-print "Detected a JDK(${vm_version}) < ${needed_version}"
1472 return 1
1473 fi
1474 fi
1475 }
1476
1477 java-pkg_set-current-vm() {
1478 export GENTOO_VM=${1}
1479 }
1480
1481 java-pkg_get-current-vm() {
1482 echo ${GENTOO_VM}
1483 }
1484
1485 java-pkg_current-vm-matches() {
1486 hasq $(java-pkg_get-current-vm) ${@}
1487 return $?
1488 }
1489
1490 # ------------------------------------------------------------------------------
1491 # @ebuild-function java-pkg_get-source
1492 #
1493 # Determines what source version should be used, for passing to -source.
1494 # Unless you want to break things you probably shouldn't set _WANT_SOURCE
1495 #
1496 # @return string - Either the lowest possible source, or JAVA_PKG_WANT_SOURCE
1497 # ------------------------------------------------------------------------------
1498 java-pkg_get-source() {
1499 echo ${JAVA_PKG_WANT_SOURCE:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1500 }
1501
1502 # ------------------------------------------------------------------------------
1503 # @ebuild-function java-pkg_get-target
1504 #
1505 # Determines what target version should be used, for passing to -target.
1506 # If you don't care about lower versions, you can set _WANT_TARGET to the
1507 # version of your JDK.
1508 #
1509 # @return string - Either the lowest possible target, or JAVA_PKG_WANT_TARGET
1510 # ------------------------------------------------------------------------------
1511 java-pkg_get-target() {
1512 echo ${JAVA_PKG_WANT_TARGET:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1513 }
1514
1515 java-pkg_get-javac() {
1516 debug-print-function ${FUNCNAME} $*
1517
1518
1519 local compiler="${GENTOO_COMPILER}"
1520
1521 local compiler_executable
1522 if [[ "${compiler}" = "javac" ]]; then
1523 # nothing fancy needs to be done for javac
1524 compiler_executable="javac"
1525 else
1526 # for everything else, try to determine from an env file
1527
1528 local compiler_env="/usr/share/java-config-2/compiler/${compiler}"
1529 if [[ -f ${compiler_env} ]]; then
1530 local old_javac=${JAVAC}
1531 unset JAVAC
1532 # try to get value of JAVAC
1533 compiler_executable="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${JAVAC})"
1534 export JAVAC=${old_javac}
1535
1536 if [[ -z ${compiler_executable} ]]; then
1537 echo "JAVAC is empty or undefined in ${compiler_env}"
1538 return 1
1539 fi
1540
1541 # check that it's executable
1542 if [[ ! -x ${compiler_executable} ]]; then
1543 echo "${compiler_executable} doesn't exist, or isn't executable"
1544 return 1
1545 fi
1546 else
1547 echo "Could not find environment file for ${compiler}"
1548 return 1
1549 fi
1550 fi
1551 echo ${compiler_executable}
1552 }
1553
1554 # ------------------------------------------------------------------------------
1555 # @ebuild-function java-pkg_javac-args
1556 #
1557 # If an ebuild uses javac directly, instead of using ejavac, it should call this
1558 # to know what -source/-target to use.
1559 #
1560 # @return string - arguments to pass to javac, complete with -target and -source
1561 # ------------------------------------------------------------------------------
1562 java-pkg_javac-args() {
1563 debug-print-function ${FUNCNAME} $*
1564
1565 local want_source="$(java-pkg_get-source)"
1566 local want_target="$(java-pkg_get-target)"
1567
1568 local source_str="-source ${want_source}"
1569 local target_str="-target ${want_target}"
1570
1571 debug-print "want source: ${want_source}"
1572 debug-print "want target: ${want_target}"
1573
1574 if [[ -z "${want_source}" || -z "${want_target}" ]]; then
1575 debug-print "could not find valid -source/-target values for javac"
1576 echo "Could not find valid -source/-target values for javac"
1577 return 1
1578 else
1579 if java-pkg_is-vm-version-ge "1.4"; then
1580 echo "${source_str} ${target_str}"
1581 else
1582 echo "${target_str}"
1583 fi
1584 fi
1585 }
1586
1587 # TODO document
1588 java-pkg_get-jni-cflags() {
1589 local flags="-I${JAVA_HOME}/include"
1590
1591 local platform="linux"
1592 use elibc_FreeBSD && platform="freebsd"
1593
1594 # TODO do a check that the directories are valid
1595 flags="${flags} -I${JAVA_HOME}/include/${platform}"
1596
1597 echo ${flags}
1598 }
1599
1600 java-pkg_ensure-gcj() {
1601 if ! built_with_use sys-devel/gcc gcj ; then
1602 ewarn
1603 ewarn "You must build gcc with the gcj support to build with gcj"
1604 ewarn
1605 ebeep 5
1606 die "No GCJ support found!"
1607 fi
1608 }
1609
1610 java-pkg_ensure-test() {
1611 if hasq test ${FEATURES} && ! hasq -test ${FEATURES} \
1612 && hasq test ${IUSE} && ! use test;
1613 then
1614 eerror "You specified FEATURES=test, but USE=test is needed"
1615 eerror "to pull in the additional dependencies for testing"
1616 die "Need USE=test enabled"
1617 fi
1618 }
1619
1620 # ------------------------------------------------------------------------------
1621 # @ebuild-function java-pkg_register-ant-task
1622 #
1623 # Register this package as ant task, so that ant will load it when no specific
1624 # ANT_TASKS are specified. Note that even without this registering, all packages
1625 # specified in ANT_TASKS will be loaded. Mostly used by the actual ant tasks
1626 # packages, but can be also used by other ebuilds that used to symlink their
1627 # .jar into /usr/share/ant-core/lib to get autoloaded, for backwards
1628 # compatibility.
1629 #
1630 # @param --version x.y Register only for ant version x.y (otherwise for any ant
1631 # version). Used by the ant-* packages to prevent loading of mismatched
1632 # ant-core ant tasks after core was updated, before the tasks are updated,
1633 # without a need for blockers.
1634 # @param $1 Name to register as. Defaults to JAVA_PKG_NAME ($PN[-$SLOT])
1635 # ------------------------------------------------------------------------------
1636 java-pkg_register-ant-task() {
1637 local TASKS_DIR="tasks"
1638
1639 # check for --version x.y parameters
1640 while [[ -n "${1}" && -n "${2}" ]]; do
1641 local var="${1#--}"
1642 local val="${2}"
1643 if [[ "${var}" == "version" ]]; then
1644 TASKS_DIR="tasks-${val}"
1645 else
1646 die "Unknown parameter passed to java-pkg_register-ant-tasks: ${1} ${2}"
1647 fi
1648 shift 2
1649 done
1650
1651 local TASK_NAME="${1:-${JAVA_PKG_NAME}}"
1652
1653 dodir /usr/share/ant/${TASKS_DIR}
1654 touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}"
1655 }
1656
1657 # ------------------------------------------------------------------------------
1658 # @internal-function java-pkg_ant-tasks-depend
1659 #
1660 # Translates the WANT_ANT_TASKS variable into valid dependencies.
1661 # ------------------------------------------------------------------------------
1662 java-pkg_ant-tasks-depend() {
1663 debug-print-function ${FUNCNAME} ${WANT_ANT_TASKS}
1664
1665 if [[ -n "${WANT_ANT_TASKS}" ]]; then
1666 local DEP=""
1667 for i in ${WANT_ANT_TASKS}
1668 do
1669 if [[ ${i} = ant-* ]]; then
1670 DEP="${DEP}dev-java/${i} "
1671 elif [[ ${i} = */*:* ]]; then
1672 DEP="${DEP}${i} "
1673 else
1674 echo "Invalid atom in WANT_ANT_TASKS: ${i}"
1675 return 1
1676 fi
1677 done
1678 echo ${DEP}
1679 return 0
1680 else
1681 return 0
1682 fi
1683 }
1684
1685 # ------------------------------------------------------------------------------
1686 # @ebuild-function ejunit
1687 #
1688 # Junit wrapper function. Makes it easier to run the tests and checks for
1689 # dev-java/junit in DEPEND. Launches the tests using junit.textui.TestRunner.
1690 #
1691 # Examples:
1692 # ejunit -cp build/classes org.blinkenlights.jid3.test.AllTests
1693 # ejunit org.blinkenlights.jid3.test.AllTests
1694 #
1695 # @param $1 - -cp or -classpath
1696 # @param $2 - classpath; junit and recorded dependencies get appended
1697 # @param $@ - the rest of the parameters are passed to java
1698 # ------------------------------------------------------------------------------
1699 ejunit() {
1700 debug-print-function ${FUNCNAME} $*
1701
1702 local pkgs
1703 if [[ -f ${JAVA_PKG_DEPEND_FILE} ]]; then
1704 for atom in $(cat ${JAVA_PKG_DEPEND_FILE} | tr : ' '); do
1705 pkgs=${pkgs},$(echo ${atom} | sed -re "s/^.*@//")
1706 done
1707 fi
1708
1709 local cp=$(java-pkg_getjars --with-dependencies junit${pkgs})
1710 if [[ ${1} = -cp || ${1} = -classpath ]]; then
1711 cp="${2}:${cp}"
1712 shift 2
1713 else
1714 cp=".:${cp}"
1715 fi
1716
1717 local runner=junit.textui.TestRunner
1718 debug-print "Calling: java -cp \"${cp}\" -Djava.awt.headless=true ${runner} ${@}"
1719 java -cp "${cp}" -Djava.awt.headless=true ${runner} "${@}" || die "Running junit failed"
1720 }
1721
1722 # ------------------------------------------------------------------------------
1723 # @section-end helper
1724 # ------------------------------------------------------------------------------
1725
1726 # ------------------------------------------------------------------------------
1727 # @eclass-src_prepare
1728 #
1729 # src_prepare Searches for bundled jars
1730 # Don't call directly, but via java-pkg-2_src_prepare!
1731 # ------------------------------------------------------------------------------
1732
1733 java-utils-2_src_prepare() {
1734 [[ ${EBUILD_PHASE} == prepare ]] &&
1735 java-pkg_func-exists java_prepare && java_prepare
1736
1737 # Remember that eant will call this unless called via Portage
1738 if [[ ! -e "${T}/java-utils-2_src_prepare-run" ]] && is-java-strict; then
1739 echo "Searching for bundled jars:"
1740 java-pkg_find-normal-jars || echo "None found."
1741 echo "Searching for bundled classes (no output if none found):"
1742 find "${WORKDIR}" -name "*.class"
1743 echo "Search done."
1744 fi
1745 touch "${T}/java-utils-2_src_prepare-run"
1746 }
1747
1748 # ------------------------------------------------------------------------------
1749 # @eclass-pkg_preinst
1750 #
1751 # pkg_preinst Searches for missing and unneeded dependencies
1752 # Don't call directly, but via java-pkg-2_pkg_preinst!
1753 # ------------------------------------------------------------------------------
1754
1755 java-utils-2_pkg_preinst() {
1756 if is-java-strict; then
1757 if has_version dev-java/java-dep-check; then
1758 [[ -e "${JAVA_PKG_ENV}" ]] || return
1759 local output=$(GENTOO_VM= java-dep-check --image "${D}" "${JAVA_PKG_ENV}")
1760 if [[ ${output} && has_version <=dev-java/java-dep-check-0.2 ]]; then
1761 ewarn "Possibly unneeded dependencies found in package.env:"
1762 for dep in ${output}; do
1763 ewarn "\t${dep}"
1764 done
1765 fi
1766 if [[ ${output} && has_version >dev-java/java-dep-check-0.2 ]]; then
1767 ewarn "${output}"
1768 fi
1769 else
1770 eerror "Install dev-java/java-dep-check for dependency checking"
1771 fi
1772 fi
1773 }
1774
1775 # ------------------------------------------------------------------------------
1776 # @section-begin build
1777 # @section-summary Build functions
1778 #
1779 # These are some functions for building a package. In particular, it consists of
1780 # wrappers for javac and ant.
1781 # ------------------------------------------------------------------------------
1782
1783 # ------------------------------------------------------------------------------
1784 # @ebuild-function eant
1785 #
1786 # Ant wrapper function. Will use the appropriate compiler, based on user-defined
1787 # compiler. Will also set proper ANT_TASKS from the variable ANT_TASKS,
1788 # variables:
1789 # EANT_GENTOO_CLASSPATH - calls java-pkg_getjars for the value and adds to the
1790 # gentoo.classpath property. Be sure to call
1791 # java-ant_rewrite-classpath in src_unpack.
1792 # EANT_NEEDS_TOOLS - add tools.jar to the gentoo.classpath. Should only be used
1793 # for build-time purposes, the dependency is not recorded to
1794 # package.env!
1795 # JAVA_PKG_NO_BUNDLED_SEARCH - Don't search for bundled jars or class files
1796 # *ANT_TASKS - used to determine ANT_TASKS before calling Ant.
1797 # ------------------------------------------------------------------------------
1798 eant() {
1799 debug-print-function ${FUNCNAME} $*
1800
1801 if [[ ${EBUILD_PHASE} = compile ]]; then
1802 java-ant-2_src_configure
1803 java-utils-2_src_prepare
1804 fi
1805
1806 if ! hasq java-ant-2 ${INHERITED}; then
1807 local msg="You should inherit java-ant-2 when using eant"
1808 java-pkg_announce-qa-violation "${msg}"
1809 fi
1810
1811 local antflags="-Dnoget=true -Dmaven.mode.offline=true -Dbuild.sysclasspath=ignore"
1812
1813 java-pkg_init-compiler_
1814 local compiler="${GENTOO_COMPILER}"
1815
1816 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1817 local build_compiler="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER})"
1818 if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then
1819 die "ANT_BUILD_COMPILER undefined in ${compiler_env}"
1820 fi
1821
1822 if [[ ${compiler} != "javac" ]]; then
1823 antflags="${antflags} -Dbuild.compiler=${build_compiler}"
1824 # Figure out any extra stuff to put on the classpath for compilers aside
1825 # from javac
1826 # ANT_BUILD_COMPILER_DEPS should be something that could be passed to
1827 # java-config -p
1828 local build_compiler_deps="$(source ${JAVA_PKG_COMPILER_DIR}/${compiler} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER_DEPS})"
1829 if [[ -n ${build_compiler_deps} ]]; then
1830 antflags="${antflags} -lib $(java-config -p ${build_compiler_deps})"
1831 fi
1832 fi
1833
1834 for arg in "${@}"; do
1835 if [[ ${arg} = -lib ]]; then
1836 if is-java-strict; then
1837 eerror "You should not use the -lib argument to eant because it will fail"
1838 eerror "with JAVA_PKG_STRICT. Please use for example java-pkg_jar-from"
1839 eerror "or ant properties to make dependencies available."
1840 eerror "For ant tasks use WANT_ANT_TASKS or ANT_TASKS from."
1841 eerror "split ant (>=dev-java/ant-core-1.7)."
1842 die "eant -lib is deprecated/forbidden"
1843 else
1844 echo "eant -lib is deprecated. Turn JAVA_PKG_STRICT on for"
1845 echo "more info."
1846 fi
1847 fi
1848 done
1849
1850 # parse WANT_ANT_TASKS for atoms
1851 local want_ant_tasks
1852 for i in ${WANT_ANT_TASKS}; do
1853 if [[ ${i} = */*:* ]]; then
1854 i=${i#*/}
1855 i=${i%:0}
1856 want_ant_tasks+="${i/:/-} "
1857 else
1858 want_ant_tasks+="${i} "
1859 fi
1860 done
1861 # default ANT_TASKS to WANT_ANT_TASKS, if ANT_TASKS is not set explicitly
1862 ANT_TASKS="${ANT_TASKS:-${want_ant_tasks% }}"
1863
1864 # override ANT_TASKS with JAVA_PKG_FORCE_ANT_TASKS if it's set
1865 ANT_TASKS="${JAVA_PKG_FORCE_ANT_TASKS:-${ANT_TASKS}}"
1866
1867 # if ant-tasks is not set by ebuild or forced, use none
1868 ANT_TASKS="${ANT_TASKS:-none}"
1869
1870 # at this point, ANT_TASKS should be "all", "none" or explicit list
1871 if [[ "${ANT_TASKS}" == "all" ]]; then
1872 einfo "Using all available ANT_TASKS"
1873 elif [[ "${ANT_TASKS}" == "none" ]]; then
1874 einfo "Disabling all optional ANT_TASKS"
1875 else
1876 einfo "Using following ANT_TASKS: ${ANT_TASKS}"
1877 fi
1878
1879 export ANT_TASKS
1880
1881 [[ -n ${JAVA_PKG_DEBUG} ]] && antflags="${antflags} --execdebug -debug"
1882 [[ -n ${PORTAGE_QUIET} ]] && antflags="${antflags} -q"
1883
1884 local gcp="${EANT_GENTOO_CLASSPATH}"
1885 local getjarsarg=""
1886
1887 if [[ ${EBUILD_PHASE} = "test" ]]; then
1888 antflags="${antflags} -DJunit.present=true"
1889 [[ ${ANT_TASKS} = *ant-junit* ]] && gcp="${gcp} junit"
1890 getjarsarg="--with-dependencies"
1891 fi
1892
1893 local cp
1894
1895 for atom in ${gcp}; do
1896 cp="${cp}:$(java-pkg_getjars ${getjarsarg} ${atom})"
1897 done
1898
1899 [[ -n "${EANT_NEEDS_TOOLS}" ]] && cp="${cp}:$(java-config --tools)"
1900
1901 if [[ ${cp} ]]; then
1902 # It seems ant does not like single quotes around ${cp}
1903 cp=${cp#:}
1904 [[ ${EANT_GENTOO_CLASSPATH_EXTRA} ]] && \
1905 cp="${cp}:${EANT_GENTOO_CLASSPATH_EXTRA}"
1906 antflags="${antflags} -Dgentoo.classpath=\"${cp}\""
1907 fi
1908
1909 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}"
1910 debug-print "Calling ant (GENTOO_VM: ${GENTOO_VM}): ${antflags} ${@}"
1911 ant ${antflags} "${@}" || die "eant failed"
1912 }
1913
1914 # ------------------------------------------------------------------------------
1915 # @ebuild-function ejavac
1916 #
1917 # Javac wrapper function. Will use the appropriate compiler, based on
1918 # /etc/java-config/compilers.conf
1919 #
1920 # @param $@ - Arguments to be passed to the compiler
1921 # ------------------------------------------------------------------------------
1922 ejavac() {
1923 debug-print-function ${FUNCNAME} $*
1924
1925 java-pkg_init-compiler_
1926
1927 local compiler_executable
1928 compiler_executable=$(java-pkg_get-javac)
1929 if [[ ${?} != 0 ]]; then
1930 eerror "There was a problem determining compiler: ${compiler_executable}"
1931 die "get-javac failed"
1932 fi
1933
1934 local javac_args
1935 javac_args="$(java-pkg_javac-args)"
1936 if [[ ${?} != 0 ]]; then
1937 eerror "There was a problem determining JAVACFLAGS: ${javac_args}"
1938 die "java-pkg_javac-args failed"
1939 fi
1940
1941 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} ${javac_args} "${@}"
1942 ${compiler_executable} ${javac_args} "${@}" || die "ejavac failed"
1943 }
1944
1945 # ------------------------------------------------------------------------------
1946 # @ebuild-function java-pkg_filter-compiler
1947 #
1948 # Used to prevent the use of some compilers. Should be used in src_compile.
1949 # Basically, it just appends onto JAVA_PKG_FILTER_COMPILER
1950 #
1951 # @param $@ - compilers to filter
1952 # ------------------------------------------------------------------------------
1953 java-pkg_filter-compiler() {
1954 JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@"
1955 }
1956
1957 # ------------------------------------------------------------------------------
1958 # @ebuild-function java-pkg_force-compiler
1959 #
1960 # Used to force the use of particular compilers. Should be used in src_compile.
1961 # A common use of this would be to force ecj-3.1 to be used on amd64, to avoid
1962 # OutOfMemoryErrors that may come up.
1963 #
1964 # @param $@ - compilers to force
1965 # ------------------------------------------------------------------------------
1966 java-pkg_force-compiler() {
1967 JAVA_PKG_FORCE_COMPILER="$@"
1968 }
1969
1970 # ------------------------------------------------------------------------------
1971 # @ebuild-function use_doc
1972 #
1973 # Helper function for getting ant to build javadocs. If the user has USE=doc,
1974 # then 'javadoc' or the argument are returned. Otherwise, there is no return.
1975 #
1976 # The output of this should be passed to ant.
1977 #
1978 # Example: build javadocs by calling 'javadoc' target
1979 # eant $(use_doc)
1980 # Example: build javadocs by calling 'apidoc' target
1981 # eant $(use_doc apidoc)
1982 #
1983 # @param $@ - Option value to return. Defaults to 'javadoc'
1984 # @return string - Name of the target to create javadocs
1985 # ------------------------------------------------------------------------------
1986 use_doc() {
1987 use doc && echo ${@:-javadoc}
1988 }
1989
1990
1991 # ------------------------------------------------------------------------------
1992 # @section-end build
1993 # ------------------------------------------------------------------------------
1994
1995 # ------------------------------------------------------------------------------
1996 # @section-begin internal
1997 # @section-summary Internal functions
1998 #
1999 # Do __NOT__ use any of these from an ebuild! These are only to be used from
2000 # within the java eclasses.
2001 # ------------------------------------------------------------------------------
2002
2003 # -----------------------------------------------------------------------------
2004 # @function-internal java-pkg_init
2005 #
2006 # The purpose of this function, as the name might imply, is to initialize the
2007 # Java environment. It ensures that that there aren't any environment variables
2008 # that'll muss things up. It initializes some variables, which are used
2009 # internally. And most importantly, it'll switch the VM if necessary.
2010 #
2011 # This shouldn't be used directly. Instead, java-pkg and java-pkg-opt will
2012 # call it during each of the phases of the merge process.
2013 #
2014 # -----------------------------------------------------------------------------
2015 java-pkg_init() {
2016 debug-print-function ${FUNCNAME} $*
2017 unset JAVAC
2018 unset JAVA_HOME
2019
2020 java-config --help >/dev/null || {
2021 eerror ""
2022 eerror "Can't run java-config --help"
2023 eerror "Have you upgraded python recently but haven't"
2024 eerror "run python-updater yet?"
2025 die "Can't run java-config --help"
2026 }
2027
2028 # People do all kinds of weird things.
2029 # http://forums.gentoo.org/viewtopic-p-3943166.html
2030 local silence="${SILENCE_JAVA_OPTIONS_WARNING}"
2031 local accept="${I_WANT_GLOBAL_JAVA_OPTIONS}"
2032 if [[ -n ${_JAVA_OPTIONS} && -z ${accept} && -z ${silence} ]]; then
2033 ewarn "_JAVA_OPTIONS changes what java -version outputs at least for"
2034 ewarn "sun-jdk vms and and as such break configure scripts that"
2035 ewarn "use it (for example app-office/openoffice) so we filter it out."
2036 ewarn "Use SILENCE_JAVA_OPTIONS_WARNING=true in the environment (use"
2037 ewarn "make.conf for example) to silence this warning or"
2038 ewarn "I_WANT_GLOBAL_JAVA_OPTIONS to not filter it."
2039 fi
2040
2041 if [[ -z ${accept} ]]; then
2042 # export _JAVA_OPTIONS= doesn't work because it will show up in java
2043 # -version output
2044 unset _JAVA_OPTIONS
2045 # phase hooks make this run many times without this
2046 I_WANT_GLOBAL_JAVA_OPTIONS="true"
2047 fi
2048
2049 if java-pkg_func-exists ant_src_unpack; then
2050 java-pkg_announce-qa-violation "Using old ant_src_unpack. Should be src_unpack"
2051 fi
2052
2053 java-pkg_init_paths_
2054 java-pkg_switch-vm
2055 PATH=${JAVA_HOME}/bin:${PATH}
2056
2057 # TODO we will probably want to set JAVAC and JAVACFLAGS
2058
2059 # Do some QA checks
2060 java-pkg_check-jikes
2061
2062 # Can't use unset here because Portage does not save the unset
2063 # see https://bugs.gentoo.org/show_bug.cgi?id=189417#c11
2064
2065 # When users have crazy classpaths some packages can fail to compile.
2066 # and everything should work with empty CLASSPATH.
2067 # This also helps prevent unexpected dependencies on random things
2068 # from the CLASSPATH.
2069 export CLASSPATH=
2070
2071 # Unset external ANT_ stuff
2072 export ANT_TASKS=
2073 export ANT_OPTS=
2074 export ANT_RESPECT_JAVA_HOME=
2075 }
2076
2077 # ------------------------------------------------------------------------------
2078 # @function-internal java-pkg-init-compiler_
2079 #
2080 # This function attempts to figure out what compiler should be used. It does
2081 # this by reading the file at JAVA_PKG_COMPILERS_CONF, and checking the
2082 # COMPILERS variable defined there.
2083 # This can be overridden by a list in JAVA_PKG_FORCE_COMPILER
2084 #
2085 # It will go through the list of compilers, and verify that it supports the
2086 # target and source that are needed. If it is not suitable, then the next
2087 # compiler is checked. When JAVA_PKG_FORCE_COMPILER is defined, this checking
2088 # isn't done.
2089 #
2090 # Once the which compiler to use has been figured out, it is set to
2091 # GENTOO_COMPILER.
2092 #
2093 # If you hadn't guessed, JAVA_PKG_FORCE_COMPILER is for testing only.
2094 #
2095 # If the user doesn't defined anything in JAVA_PKG_COMPILERS_CONF, or no
2096 # suitable compiler was found there, then the default is to use javac provided
2097 # by the current VM.
2098 #
2099 #
2100 # @return name of the compiler to use
2101 # ------------------------------------------------------------------------------
2102 java-pkg_init-compiler_() {
2103 debug-print-function ${FUNCNAME} $*
2104
2105 if [[ -n ${GENTOO_COMPILER} ]]; then
2106 debug-print "GENTOO_COMPILER already set"
2107 return
2108 fi
2109
2110 local compilers;
2111 if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
2112 compilers="$(source ${JAVA_PKG_COMPILERS_CONF} 1>/dev/null 2>&1; echo ${COMPILERS})"
2113 else
2114 compilers=${JAVA_PKG_FORCE_COMPILER}
2115 fi
2116
2117 debug-print "Read \"${compilers}\" from ${JAVA_PKG_COMPILERS_CONF}"
2118
2119 # Figure out if we should announce what compiler we're using
2120 local compiler
2121 for compiler in ${compilers}; do
2122 debug-print "Checking ${compiler}..."
2123 # javac should always be alright
2124 if [[ ${compiler} = "javac" ]]; then
2125 debug-print "Found javac... breaking"
2126 export GENTOO_COMPILER="javac"
2127 break
2128 fi
2129
2130 if has ${compiler} ${JAVA_PKG_FILTER_COMPILER}; then
2131 if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
2132 einfo "Filtering ${compiler}"
2133 continue
2134 fi
2135 fi
2136
2137 # for non-javac, we need to make sure it supports the right target and
2138 # source
2139 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
2140 if [[ -f ${compiler_env} ]]; then
2141 local desired_target="$(java-pkg_get-target)"
2142 local desired_source="$(java-pkg_get-source)"
2143
2144
2145 # Verify that the compiler supports target
2146 local supported_target=$(source ${compiler_env} 1>/dev/null 2>&1; echo ${SUPPORTED_TARGET})
2147 if ! has ${desired_target} ${supported_target}; then
2148 ewarn "${compiler} does not support -target ${desired_target}, skipping"
2149 continue
2150 fi
2151
2152 # -source was introduced in 1.3, so only check 1.3 and on
2153 if version_is_at_least "${desired_soure}" "1.3"; then
2154 # Verify that the compiler supports source
2155 local supported_source=$(source ${compiler_env} 1>/dev/null 2>&1; echo ${SUPPORTED_SOURCE})
2156 if ! has ${desired_source} ${supported_source}; then
2157 ewarn "${compiler} does not support -source ${desired_source}, skipping"
2158 continue
2159 fi
2160 fi
2161
2162 # if you get here, then the compiler should be good to go
2163 export GENTOO_COMPILER="${compiler}"
2164 break
2165 else
2166 ewarn "Could not find configuration for ${compiler}, skipping"
2167 ewarn "Perhaps it is not installed?"
2168 continue
2169 fi
2170 done
2171
2172 # If it hasn't been defined already, default to javac
2173 if [[ -z ${GENTOO_COMPILER} ]]; then
2174 if [[ -n ${compilers} ]]; then
2175 einfo "No suitable compiler found: defaulting to JDK default for compilation"
2176 else
2177 # probably don't need to notify users about the default.
2178 :;#einfo "Defaulting to javac for compilation"
2179 fi
2180 if java-config -g GENTOO_COMPILER 2> /dev/null; then
2181 export GENTOO_COMPILER=$(java-config -g GENTOO_COMPILER)
2182 else
2183 export GENTOO_COMPILER=javac
2184 fi
2185 else
2186 einfo "Using ${GENTOO_COMPILER} for compilation"
2187 fi
2188
2189 }
2190
2191 # ------------------------------------------------------------------------------
2192 # @internal-function init_paths_
2193 #
2194 # Initializes some variables that will be used. These variables are mostly used
2195 # to determine where things will eventually get installed.
2196 # ------------------------------------------------------------------------------
2197 java-pkg_init_paths_() {
2198 debug-print-function ${FUNCNAME} $*
2199
2200 local pkg_name
2201 if [[ "$SLOT" == "0" ]] ; then
2202 JAVA_PKG_NAME="${PN}"
2203 else
2204 JAVA_PKG_NAME="${PN}-${SLOT}"
2205 fi
2206
2207 JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}"
2208 JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/"
2209 JAVA_PKG_ENV="${D}${JAVA_PKG_SHAREPATH}/package.env"
2210 JAVA_PKG_VIRTUALS_PATH="${DESTTREE}/share/java-config-2/virtuals"
2211 JAVA_PKG_VIRTUAL_PROVIDER="${D}/${JAVA_PKG_VIRTUALS_PATH}/${JAVA_PKG_NAME}"
2212
2213 [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib"
2214 [[ -z "${JAVA_PKG_LIBDEST}" ]] && JAVA_PKG_LIBDEST="${DESTTREE}/$(get_libdir)/${JAVA_PKG_NAME}"
2215 [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps"
2216
2217
2218 # TODO maybe only print once?
2219 debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}"
2220 debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}"
2221 debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}"
2222 debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}"
2223 debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}"
2224 }
2225
2226 # ------------------------------------------------------------------------------
2227 # @internal-function java-pkg_do_write_
2228 #
2229 # Writes the package.env out to disk.
2230 #
2231 # ------------------------------------------------------------------------------
2232 # TODO change to do-write, to match everything else
2233 java-pkg_do_write_() {
2234 debug-print-function ${FUNCNAME} $*
2235 java-pkg_init_paths_
2236 # Create directory for package.env
2237 dodir "${JAVA_PKG_SHAREPATH}"
2238 if [[ -n "${JAVA_PKG_CLASSPATH}" || -n "${JAVA_PKG_LIBRARY}" || -f \
2239 "${JAVA_PKG_DEPEND_FILE}" || -f \
2240 "${JAVA_PKG_OPTIONAL_DEPEND_FILE}" ]]; then
2241 # Create package.env
2242 (
2243 echo "DESCRIPTION=\"${DESCRIPTION}\""
2244 echo "GENERATION=\"2\""
2245 echo "SLOT=\"${SLOT}\""
2246
2247 [[ -n "${JAVA_PKG_CLASSPATH}" ]] && echo "CLASSPATH=\"${JAVA_PKG_CLASSPATH}\""
2248 [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\""
2249 [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\""
2250 [[ -f "${JAVA_PKG_DEPEND_FILE}" ]] \
2251 && echo "DEPEND=\"$(cat "${JAVA_PKG_DEPEND_FILE}" | uniq | tr '\n' ':')\""
2252 [[ -f "${JAVA_PKG_OPTIONAL_DEPEND_FILE}" ]] \
2253 && echo "OPTIONAL_DEPEND=\"$(cat "${JAVA_PKG_OPTIONAL_DEPEND_FILE}" | uniq | tr '\n' ':')\""
2254 echo "VM=\"$(echo ${RDEPEND} ${DEPEND} | sed -e 's/ /\n/g' | sed -n -e '/virtual\/\(jre\|jdk\)/ { p;q }')\"" # TODO cleanup !
2255 ) > "${JAVA_PKG_ENV}"
2256
2257 # register target/source
2258 local target="$(java-pkg_get-target)"
2259 local source="$(java-pkg_get-source)"
2260 [[ -n ${target} ]] && echo "TARGET=\"${target}\"" >> "${JAVA_PKG_ENV}"
2261 [[ -n ${source} ]] && echo "SOURCE=\"${source}\"" >> "${JAVA_PKG_ENV}"
2262
2263 # register javadoc info
2264 [[ -n ${JAVADOC_PATH} ]] && echo "JAVADOC_PATH=\"${JAVADOC_PATH}\"" \
2265 >> ${JAVA_PKG_ENV}
2266 # register source archives
2267 [[ -n ${JAVA_SOURCES} ]] && echo "JAVA_SOURCES=\"${JAVA_SOURCES}\"" \
2268 >> ${JAVA_PKG_ENV}
2269
2270
2271 echo "MERGE_VM=\"${GENTOO_VM}\"" >> "${JAVA_PKG_ENV}"
2272 [[ -n ${GENTOO_COMPILER} ]] && echo "MERGE_COMPILER=\"${GENTOO_COMPILER}\"" >> "${JAVA_PKG_ENV}"
2273
2274 # extra env variables
2275 if [[ -n "${JAVA_PKG_EXTRA_ENV_VARS}" ]]; then
2276 cat "${JAVA_PKG_EXTRA_ENV}" >> "${JAVA_PKG_ENV}" || die
2277 # nested echo to remove leading/trailing spaces
2278 echo "ENV_VARS=\"$(echo ${JAVA_PKG_EXTRA_ENV_VARS})\"" \
2279 >> "${JAVA_PKG_ENV}" || die
2280 fi
2281
2282 # Strip unnecessary leading and trailing colons
2283 # TODO try to cleanup if possible
2284 sed -e "s/=\":/=\"/" -e "s/:\"$/\"/" -i "${JAVA_PKG_ENV}" || die "Did you forget to call java_init ?"
2285 else
2286 debug-print "JAVA_PKG_CLASSPATH, JAVA_PKG_LIBRARY, JAVA_PKG_DEPEND_FILE"
2287 debug-print "or JAVA_PKG_OPTIONAL_DEPEND_FILE not defined so can't"
2288 debug-print "write package.env."
2289 fi
2290 }
2291
2292 # ------------------------------------------------------------------------------
2293 # @internal-function java-pkg_record-jar_
2294 #
2295 # Record an (optional) dependency to the package.env
2296 # @param --optional - record dependency as optional
2297 # @param $1 - package to record
2298 # @param $2 - (optional) jar of package to record
2299 # ------------------------------------------------------------------------------
2300 JAVA_PKG_DEPEND_FILE="${T}/java-pkg-depend"
2301 JAVA_PKG_OPTIONAL_DEPEND_FILE="${T}/java-pkg-optional-depend"
2302
2303 java-pkg_record-jar_() {
2304 debug-print-function ${FUNCNAME} $*
2305
2306 local depend_file="${JAVA_PKG_DEPEND_FILE}"
2307 if [[ "${1}" == "--optional" ]]; then
2308 depend_file="${JAVA_PKG_OPTIONAL_DEPEND_FILE}"
2309 shift
2310 fi
2311
2312 local pkg=${1} jar=${2} append
2313 if [[ -z "${jar}" ]]; then
2314 append="${pkg}"
2315 else
2316 append="$(basename ${jar})@${pkg}"
2317 fi
2318
2319 echo "${append}" >> "${depend_file}"
2320 }
2321
2322 # ------------------------------------------------------------------------------
2323 # @internal-function java-pkg_append_
2324 #
2325 # Appends a value to a variable
2326 #
2327 # Example: java-pkg_append_ CLASSPATH foo.jar
2328 # @param $1 variable name to modify
2329 # @param $2 value to append
2330 # ------------------------------------------------------------------------------
2331 java-pkg_append_() {
2332 debug-print-function ${FUNCNAME} $*
2333
2334 local var="${1}" value="${2}"
2335 if [[ -z "${!var}" ]] ; then
2336 export ${var}="${value}"
2337 else
2338 local oldIFS=${IFS} cur haveit
2339 IFS=':'
2340 for cur in ${!var}; do
2341 if [[ ${cur} == ${value} ]]; then
2342 haveit="yes"
2343 break
2344 fi
2345 done
2346 [[ -z ${haveit} ]] && export ${var}="${!var}:${value}"
2347 IFS=${oldIFS}
2348 fi
2349 }
2350
2351 # ------------------------------------------------------------------------------
2352 # @internal-function java-pkg_expand_dir_
2353 #
2354 # Gets the full path of the file/directory's parent.
2355 # @param $1 - file/directory to find parent directory for
2356 # @return - path to $1's parent directory
2357 # ------------------------------------------------------------------------------
2358 java-pkg_expand_dir_() {
2359 pushd "$(dirname "${1}")" >/dev/null 2>&1
2360 pwd
2361 popd >/dev/null 2>&1
2362 }
2363
2364 # ------------------------------------------------------------------------------
2365 # @internal-function java-pkg_func-exists
2366 #
2367 # Does the indicated function exist?
2368 #
2369 # @return 0 - function is declared
2370 # @return 1 - function is undeclared
2371 # ------------------------------------------------------------------------------
2372 java-pkg_func-exists() {
2373 declare -F ${1} > /dev/null
2374 }
2375
2376 # ------------------------------------------------------------------------------
2377 # @internal-function java-pkg_setup-vm
2378 #
2379 # Sets up the environment for a specific VM
2380 #
2381 # ------------------------------------------------------------------------------
2382 java-pkg_setup-vm() {
2383 debug-print-function ${FUNCNAME} $*
2384
2385 export LANG="C" LC_ALL="C"
2386
2387 local vendor="$(java-pkg_get-vm-vendor)"
2388 if [[ "${vendor}" == "sun" ]] && java-pkg_is-vm-version-ge "1.5" ; then
2389 addpredict "/dev/random"
2390 elif [[ "${vendor}" == "ibm" ]]; then
2391 addpredict "/proc/self/maps"
2392 addpredict "/proc/cpuinfo"
2393 elif [[ "${vendor}" == "jrockit" ]]; then
2394 addpredict "/proc/cpuinfo"
2395 fi
2396 }
2397
2398 # ------------------------------------------------------------------------------
2399 # @internal-function java-pkg_needs-vm
2400 #
2401 # Does the current package depend on virtual/jdk?
2402 #
2403 # @return 0 - Package depends on virtual/jdk
2404 # @return 1 - Package does not depend on virtual/jdk
2405 # ------------------------------------------------------------------------------
2406 java-pkg_needs-vm() {
2407 debug-print-function ${FUNCNAME} $*
2408
2409 if [[ -n "$(echo ${DEPEND} | sed -e '\:virtual/jdk:!d')" ]]; then
2410 return 0
2411 fi
2412
2413 return 1
2414 }
2415
2416 # ------------------------------------------------------------------------------
2417 # @internal-function java-pkg_get-current-vm
2418 #
2419 # @return - The current VM being used
2420 # ------------------------------------------------------------------------------
2421 java-pkg_get-current-vm() {
2422 java-config -f
2423 }
2424
2425 # ------------------------------------------------------------------------------
2426 # @internal-function java-pkg_get-vm-vendor
2427 #
2428 # @return - The vendor of the current VM
2429 # ------------------------------------------------------------------------------
2430 java-pkg_get-vm-vendor() {
2431 debug-print-function ${FUNCNAME} $*
2432
2433 local vm="$(java-pkg_get-current-vm)"
2434 vm="${vm/-*/}"
2435 echo "${vm}"
2436 }
2437
2438 # ------------------------------------------------------------------------------
2439 # @internal-function java-pkg_get-vm-version
2440 #
2441 # @return - The version of the current VM
2442 # ------------------------------------------------------------------------------
2443 java-pkg_get-vm-version() {
2444 debug-print-function ${FUNCNAME} $*
2445
2446 java-config -g PROVIDES_VERSION
2447 }
2448
2449 # ------------------------------------------------------------------------------
2450 # @internal-function java-pkg_switch-vm
2451 #
2452 # Switch VM if we're allowed to (controlled by JAVA_PKG_ALLOW_VM_CHANGE), and
2453 # verify that the current VM is sufficient.
2454 # Setup the environment for the VM being used.
2455 # ------------------------------------------------------------------------------
2456 java-pkg_switch-vm() {
2457 debug-print-function ${FUNCNAME} $*
2458
2459 if java-pkg_needs-vm; then
2460 # Use the VM specified by JAVA_PKG_FORCE_VM
2461 if [[ -n "${JAVA_PKG_FORCE_VM}" ]]; then
2462 # If you're forcing the VM, I hope you know what your doing...
2463 debug-print "JAVA_PKG_FORCE_VM used: ${JAVA_PKG_FORCE_VM}"
2464 export GENTOO_VM="${JAVA_PKG_FORCE_VM}"
2465 # if we're allowed to switch the vm...
2466 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then
2467 debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
2468 GENTOO_VM="$(depend-java-query --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")"
2469 if [[ -z "${GENTOO_VM}" || "${GENTOO_VM}" == "None" ]]; then
2470 eerror "Unable to determine VM for building from dependencies:"
2471 echo "NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
2472 die "Failed to determine VM for building."
2473 else
2474 export GENTOO_VM
2475 fi
2476 # otherwise just make sure the current VM is sufficient
2477 else
2478 java-pkg_ensure-vm-version-sufficient
2479 fi
2480 debug-print "Using: $(java-config -f)"
2481
2482 java-pkg_setup-vm
2483
2484 export JAVA=$(java-config --java)
2485 export JAVAC=$(java-config --javac)
2486 JAVACFLAGS="$(java-pkg_javac-args)"
2487 if [[ ${?} != 0 ]]; then
2488 eerror "There was a problem determining JAVACFLAGS: ${JAVACFLAGS}"
2489 die "java-pkg_javac-args failed"
2490 fi
2491 [[ -n ${JAVACFLAGS_EXTRA} ]] && JAVACFLAGS="${JAVACFLAGS_EXTRA} ${JAVACFLAGS}"
2492 export JAVACFLAGS
2493
2494 export JAVA_HOME="$(java-config -g JAVA_HOME)"
2495 export JDK_HOME=${JAVA_HOME}
2496
2497 #TODO If you know a better solution let us know.
2498 java-pkg_append_ LD_LIBRARY_PATH "$(java-config -g LDPATH)"
2499
2500 local tann="${T}/announced-vm"
2501 # With the hooks we should only get here once from pkg_setup but better safe than sorry
2502 # if people have for example modified eclasses some where
2503 if [[ -n "${JAVA_PKG_DEBUG}" ]] || [[ ! -f "${tann}" ]] ; then
2504 einfo "Using: $(java-config -f)"
2505 [[ ! -f "${tann}" ]] && touch "${tann}"
2506 fi
2507
2508 else
2509 [[ -n "${JAVA_PKG_DEBUG}" ]] && ewarn "!!! This package inherits java-pkg but doesn't depend on a JDK. -bin or broken dependency!!!"
2510 fi
2511 }
2512
2513 # ------------------------------------------------------------------------------
2514 # @internal-function java-pkg_die
2515 #
2516 # Enhanced die for Java packages, which displays some information that may be
2517 # useful for debugging bugs on bugzilla.
2518 # ------------------------------------------------------------------------------
2519 #register_die_hook java-pkg_die
2520 if ! hasq java-pkg_die ${EBUILD_DEATH_HOOKS}; then
2521 EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die"
2522 fi
2523
2524 java-pkg_die() {
2525 echo "!!! When you file a bug report, please include the following information:" >&2
2526 echo "GENTOO_VM=${GENTOO_VM} CLASSPATH=\"${CLASSPATH}\" JAVA_HOME=\"${JAVA_HOME}\"" >&2
2527 echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2
2528 echo "and of course, the output of emerge --info" >&2
2529 }
2530
2531
2532 # TODO document
2533 # List jars in the source directory, ${S}
2534 java-pkg_jar-list() {
2535 if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
2536 einfo "Linked Jars"
2537 find "${S}" -type l -name '*.jar' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2538 einfo "Jars"
2539 find "${S}" -type f -name '*.jar' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2540 einfo "Classes"
2541 find "${S}" -type f -name '*.class' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2542 fi
2543 }
2544
2545 # ------------------------------------------------------------------------------
2546 # @internal-function java-pkg_verify-classes
2547 #
2548 # Verify that the classes were compiled for the right source / target. Dies if
2549 # not.
2550 # @param $1 (optional) - the file to check, otherwise checks whole ${D}
2551 # ------------------------------------------------------------------------------
2552 java-pkg_verify-classes() {
2553 #$(find ${D} -type f -name '*.jar' -o -name '*.class')
2554
2555 local version_verify="/usr/bin/class-version-verify.py"
2556
2557 if [[ ! -x "${version_verify}" ]]; then
2558 version_verify="/usr/$(get_libdir)/javatoolkit/bin/class-version-verify.py"
2559 fi
2560
2561 if [[ ! -x "${version_verify}" ]]; then
2562 ewarn "Unable to perform class version checks as"
2563 ewarn "class-version-verify.py is unavailable"
2564 ewarn "Please install dev-java/javatoolkit."
2565 return
2566 fi
2567
2568 local target=$(java-pkg_get-target)
2569 local result
2570 local log="${T}/class-version-verify.log"
2571 if [[ -n "${1}" ]]; then
2572 ${version_verify} -v -t ${target} "${1}" > "${log}"
2573 result=$?
2574 else
2575 ebegin "Verifying java class versions (target: ${target})"
2576 ${version_verify} -v -t ${target} -r "${D}" > "${log}"
2577 result=$?
2578 eend ${result}
2579 fi
2580 [[ -n ${JAVA_PKG_DEBUG} ]] && cat "${log}"
2581 if [[ ${result} != 0 ]]; then
2582 eerror "Incorrect bytecode version found"
2583 [[ -n "${1}" ]] && eerror "in file: ${1}"
2584 eerror "See ${log} for more details."
2585 die "Incorrect bytecode found"
2586 fi
2587 }
2588
2589 # ----------------------------------------------------------------------------
2590 # @internal-function java-pkg_ensure-dep
2591 # Check that a package being used in jarfrom, getjars and getjar is contained
2592 # within DEPEND or RDEPEND.
2593 # @param $1 - empty - check both vars; "runtime" or "build" - check only
2594 # RDEPEND, resp. DEPEND
2595 # @param $2 - Package name and slot.
2596
2597 java-pkg_ensure-dep() {
2598 debug-print-function ${FUNCNAME} $*
2599
2600 local limit_to="${1}"
2601 local target_pkg="${2}"
2602 local dev_error=""
2603
2604 local stripped_pkg=$(echo "${target_pkg}" | sed \
2605 's/-[0-9]*\(\.[0-9]\)*$//')
2606
2607 debug-print "Matching against: ${stripped_pkg}"
2608
2609 if [[ ${limit_to} != runtime && ! ( "${DEPEND}" =~ "$stripped_pkg" ) ]]; then
2610 dev_error="The ebuild is attempting to use ${target_pkg} that is not"
2611 dev_error="${dev_error} declared in DEPEND."
2612 if is-java-strict; then
2613 eerror "${dev_error}"
2614 die "${dev_error}"
2615 elif [[ ${BASH_SUBSHELL} = 0 ]]; then
2616 eerror "${dev_error}"
2617 elog "Because you have this package installed the package will"
2618 elog "build without problems, but please report this to"
2619 elog "http://bugs.gentoo.org"
2620 fi
2621 fi
2622
2623 if [[ ${limit_to} != build ]]; then
2624 if [[ ! ( ${RDEPEND} =~ "${stripped_pkg}" ) ]]; then
2625 if [[ ! ( ${PDEPEND} =~ "${stripped_pkg}" ) ]]; then
2626 dev_error="The ebuild is attempting to use ${target_pkg},"
2627 dev_error="${dev_error} without specifying --build-only, that is not declared in RDEPEND"
2628 dev_error="${dev_error} or PDEPEND."
2629 if is-java-strict; then
2630 eerror "${dev_error}"
2631 die "${dev_error}"
2632 elif [[ ${BASH_SUBSHELL} = 0 ]]; then
2633 eerror "${dev_error}"
2634 elog "The package will build without problems, but may fail to run"
2635 elog "if you don't have ${target_pkg} installed, so please report"
2636 elog "this to http://bugs.gentoo.org"
2637 fi
2638 fi
2639 fi
2640 fi
2641 }
2642
2643 # ------------------------------------------------------------------------------
2644 # @section-end internal
2645 # ------------------------------------------------------------------------------
2646
2647 java-pkg_check-phase() {
2648 local phase=${1}
2649 local funcname=${FUNCNAME[1]}
2650 if [[ ${EBUILD_PHASE} != ${phase} ]]; then
2651 local msg="${funcname} used outside of src_${phase}"
2652 java-pkg_announce-qa-violation "${msg}"
2653 fi
2654 }
2655
2656 java-pkg_check-versioned-jar() {
2657 local jar=${1}
2658
2659 if [[ ${jar} =~ ${PV} ]]; then
2660 java-pkg_announce-qa-violation "installing versioned jar '${jar}'"
2661 fi
2662 }
2663
2664 java-pkg_check-jikes() {
2665 if hasq jikes ${IUSE}; then
2666 java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE"
2667 fi
2668 }
2669
2670 java-pkg_announce-qa-violation() {
2671 local nodie
2672 if [[ ${1} == "--nodie" ]]; then
2673 nodie="true"
2674 shift
2675 fi
2676 echo "Java QA Notice: $@" >&2
2677 increment-qa-violations
2678 [[ -z "${nodie}" ]] && is-java-strict && die "${@}"
2679 }
2680
2681 increment-qa-violations() {
2682 let "JAVA_PKG_QA_VIOLATIONS+=1"
2683 export JAVA_PKG_QA_VIOLATIONS
2684 }
2685
2686 is-java-strict() {
2687 [[ -n ${JAVA_PKG_STRICT} ]]
2688 return $?
2689 }
2690
2691
2692 # ------------------------------------------------------------------------------
2693 # @eclass-end
2694 # ------------------------------------------------------------------------------

  ViewVC Help
Powered by ViewVC 1.1.20