/[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.85 - (show annotations) (download)
Fri May 25 10:27:57 2007 UTC (6 years, 10 months ago) by caster
Branch: MAIN
Changes since 1.84: +36 -2 lines
Add java-pkg_register-environment-variable function. Needs new java-config release before it can be used.

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

  ViewVC Help
Powered by ViewVC 1.1.20