/[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.130 - (show annotations) (download)
Sun Nov 8 20:39:30 2009 UTC (4 years, 8 months ago) by caster
Branch: MAIN
Changes since 1.129: +18 -1 lines
Add support for rewriting bootclasspath in build.xml and JAVA_PKG_WANT_BOOTCLASSPATH variable.

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

  ViewVC Help
Powered by ViewVC 1.1.20