/[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.69 - (show annotations) (download)
Sat Apr 7 08:52:46 2007 UTC (7 years, 5 months ago) by vapier
Branch: MAIN
Changes since 1.68: +9 -3 lines
replace INSDESTTREE/INSOPTIONS with subshells and insinto/insopts

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.68 2007/03/25 10:02:09 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 local dir="$1"
562
563 java-pkg_check-phase install
564
565 [[ -z "${dir}" ]] && die "Must specify a directory!"
566 [[ ! -d "${dir}" ]] && die "${dir} does not exist, or isn't a directory!"
567
568 local dir_to_install="${dir}"
569 if [[ "$(basename "${dir}")" != "api" ]]; then
570 dir_to_install="${T}/api"
571 # TODO use doins
572 cp -r "${dir}" "${dir_to_install}" || die "cp failed"
573 fi
574
575 java-pkg_dohtml -r ${dir_to_install}
576 }
577
578 # ------------------------------------------------------------------------------
579 # @ebuild-function java-pkg_dosrc
580 #
581 # Installs a zip containing the source for a package, so it can used in
582 # from IDEs like eclipse and netbeans.
583 #
584 # Ebuild needs to DEPEND on app-arch/zip to use this.
585 #
586 # It also should be controlled by USE=source.
587 #
588 # @example:
589 # java-pkg_dosrc src/*
590 #
591 # ------------------------------------------------------------------------------
592 # TODO change so it the arguments it takes are the base directories containing
593 # source -nichoj
594 # TODO should we be able to handle multiple calls to dosrc? -nichoj
595 # TODO maybe we can take an existing zip/jar? -nichoj
596 # FIXME apparently this fails if you give it an empty directories
597 java-pkg_dosrc() {
598 debug-print-function ${FUNCNAME} $*
599
600 [ ${#} -lt 1 ] && die "At least one argument needed"
601
602 java-pkg_check-phase install
603
604 [[ ${#} -lt 1 ]] && die "At least one argument needed"
605
606 if ! [[ ${DEPEND} = *app-arch/zip* ]]; then
607 local msg="${FUNCNAME} called without app-arch/zip in DEPEND"
608 if is-java-strict; then
609 eerror "${msg}"
610 die "${msg}"
611 else
612 echo "${msg}"
613 echo "Please report this to http://bugs.gentoo.org."
614 fi
615 fi
616
617 java-pkg_init_paths_
618
619 local zip_name="${PN}-src.zip"
620 local zip_path="${T}/${zip_name}"
621 local dir
622 for dir in "${@}"; do
623 local dir_parent=$(dirname "${dir}")
624 local dir_name=$(basename "${dir}")
625 pushd ${dir_parent} > /dev/null || die "problem entering ${dir_parent}"
626 zip -q -r ${zip_path} ${dir_name} -i '*.java'
627 local result=$?
628 # 12 means zip has nothing to do
629 if [[ ${result} != 12 && ${result} != 0 ]]; then
630 die "failed to zip ${dir_name}"
631 fi
632 popd >/dev/null
633 done
634
635 # Install the zip
636 INSDESTTREE=${JAVA_PKG_SOURCESPATH} \
637 doins ${zip_path} || die "Failed to install source"
638
639 JAVA_SOURCES="${JAVA_PKG_SOURCESPATH}/${zip_name}"
640 java-pkg_do_write_
641 }
642
643 # ------------------------------------------------------------------------------
644 # @ebuild-function java-pkg_dolauncher
645 #
646 # Make a wrapper script to lauch/start this package
647 # If necessary, the wrapper will switch to the appropriate VM.
648 #
649 # Can be called without parameters if the package installs only one jar
650 # that has the Main-class attribute set. The wrapper will be named ${PN}.
651 #
652 # @param $1 - filename of launcher to create
653 # @param $2 - options, as follows:
654 # --main the.main.class.too.start
655 # --jar /the/jar/too/launch.jar or just <name>.jar
656 # --java_args 'Extra arguments to pass to java'
657 # --pkg_args 'Extra arguments to pass to the package'
658 # --pwd Directory the launcher changes to before executing java
659 # -into Directory to install the launcher to, instead of /usr/bin
660 # -pre Prepend contents of this file to the launcher
661 # ------------------------------------------------------------------------------
662 java-pkg_dolauncher() {
663 debug-print-function ${FUNCNAME} $*
664
665 java-pkg_check-phase install
666 java-pkg_init_paths_
667
668 if [[ ${#} = 0 ]]; then
669 local name="${PN}"
670 else
671 local name="${1}"
672 shift
673 fi
674
675 # TODO rename to launcher
676 local target="${T}/${name}"
677 local var_tmp="${T}/launcher_variables_tmp"
678 local target_dir pre
679
680 # Process the other the rest of the arguments
681 while [[ -n "${1}" && -n "${2}" ]]; do
682 local var="${1}" value="${2}"
683 if [[ "${var:0:2}" == "--" ]]; then
684 local var=${var:2}
685 echo "gjl_${var}=\"${value}\"" >> "${var_tmp}"
686 local gjl_${var}="${value}"
687 elif [[ "${var}" == "-into" ]]; then
688 target_dir="${value}"
689 elif [[ "${var}" == "-pre" ]]; then
690 pre="${value}"
691 fi
692 shift 2
693 done
694
695 # Test if no --jar and --main arguments were given and
696 # in that case check if the package only installs one jar
697 # and use that jar.
698 if [[ -z "${gjl_jar}" && -z "${gjl_main}" ]]; then
699 local cp="${JAVA_PKG_CLASSPATH}"
700 if [[ "${cp/:}" = "${cp}" && "${cp%.jar}" != "${cp}" ]]; then
701 echo "gjl_jar=\"${JAVA_PKG_CLASSPATH}\"" >> "${var_tmp}"
702 else
703 local msg="Not enough information to create a launcher given."
704 msg="${msg} Please give --jar or --main argument to ${FUNCNAME}."
705 die "${msg}"
706 fi
707 fi
708
709 # Write the actual script
710 echo "#!/bin/bash" > "${target}"
711 if [[ -n "${pre}" ]]; then
712 if [[ -f "${pre}" ]]; then
713 cat "${pre}" >> "${target}"
714 else
715 die "-pre specified file '${pre}' does not exist"
716 fi
717 fi
718 echo "gjl_package=${JAVA_PKG_NAME}" >> "${target}"
719 cat "${var_tmp}" >> "${target}"
720 rm -f "${var_tmp}"
721 echo "source /usr/share/java-config-2/launcher/launcher.bash" >> "${target}"
722
723 if [[ -n "${target_dir}" ]]; then
724 DESTTREE="${target_dir}" dobin "${target}"
725 local ret=$?
726 return ${ret}
727 else
728 dobin "${target}"
729 fi
730 }
731
732 # ------------------------------------------------------------------------------
733 # Install war files.
734 # TODO document
735 # ------------------------------------------------------------------------------
736 java-pkg_dowar() {
737 debug-print-function ${FUNCNAME} $*
738
739 # Check for arguments
740 [[ ${#} -lt 1 ]] && die "At least one argument needed"
741 java-pkg_check-phase install
742
743 java-pkg_init_paths_
744
745 local war
746 for war in $* ; do
747 local warpath
748 # TODO evaluate if we want to handle symlinks differently -nichoj
749 # Check for symlink
750 if [[ -L "${war}" ]] ; then
751 cp "${war}" "${T}"
752 warpath="${T}$(basename "${war}")"
753 # Check for directory
754 # TODO evaluate if we want to handle directories differently -nichoj
755 elif [[ -d "${war}" ]] ; then
756 echo "dowar: warning, skipping directory ${war}"
757 continue
758 else
759 warpath="${war}"
760 fi
761
762 # Install those files like you mean it
763 INSOPTIONS="-m 0644" \
764 INSDESTTREE=${JAVA_PKG_WARDEST} \
765 doins ${warpath}
766 done
767 }
768
769 # ------------------------------------------------------------------------------
770 # @internal-function java-pkg_recordjavadoc
771 # Scan for JavaDocs, and record their existence in the package.env file
772 #
773 # TODO make sure this in the proper section
774 # ------------------------------------------------------------------------------
775 java-pkg_recordjavadoc()
776 {
777 debug-print-function ${FUNCNAME} $*
778 # the find statement is important
779 # as some packages include multiple trees of javadoc
780 JAVADOC_PATH="$(find ${D}/usr/share/doc/ -name allclasses-frame.html -printf '%h:')"
781 # remove $D - TODO: check this is ok with all cases of the above
782 JAVADOC_PATH="${JAVADOC_PATH//${D}}"
783 if [[ -n "${JAVADOC_PATH}" ]] ; then
784 debug-print "javadocs found in ${JAVADOC_PATH%:}"
785 java-pkg_do_write_
786 else
787 debug-print "No javadocs found"
788 fi
789 }
790
791 # ------------------------------------------------------------------------------
792 # @section-end install
793 # ------------------------------------------------------------------------------
794
795 # ------------------------------------------------------------------------------
796 # @begin-section query
797 # Use these to build the classpath for building a package.
798 # ------------------------------------------------------------------------------
799
800 # ------------------------------------------------------------------------------
801 # @ebuild-function java-pkg_jar-from
802 #
803 # Makes a symlink to a jar from a certain package
804 # A lot of java packages include dependencies in a lib/ directory
805 # You can use this function to replace these bundled dependencies.
806 # The dependency is recorded into package.env DEPEND line, unless "--build-only"
807 # is passed as the very first argument, for jars that have to be present only
808 # at build time and are not needed on runtime (junit testing etc).
809 #
810 # Example: get all jars from xerces slot 2
811 # java-pkg_jar-from xerces-2
812 # Example: get a specific jar from xerces slot 2
813 # java-pkg_jar-from xerces-2 xml-apis.jar
814 # Example: get a specific jar from xerces slot 2, and name it diffrently
815 # java-pkg_jar-from xerces-2 xml-apis.jar xml.jar
816 # Example: get junit.jar which is needed only for building
817 # java-pkg_jar-from --build-only junit junit.jar
818 #
819 # @param $opt
820 # --build-only - makes the jar(s) not added into package.env DEPEND line.
821 # (assumed automatically when called inside src_test)
822 # --with-dependencies - get jars also from requested package's dependencies
823 # transitively.
824 # --into $dir - symlink jar(s) into $dir (must exist) instead of .
825 # @param $1 - Package to get jars from.
826 # @param $2 - jar from package. If not specified, all jars will be used.
827 # @param $3 - When a single jar is specified, destination filename of the
828 # symlink. Defaults to the name of the jar.
829 # ------------------------------------------------------------------------------
830 # TODO could probably be cleaned up a little
831 java-pkg_jar-from() {
832 debug-print-function ${FUNCNAME} $*
833
834 local build_only=""
835 local destdir="."
836 local deep=""
837
838 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="true"
839
840 while [[ "${1}" == --* ]]; do
841 if [[ "${1}" = "--build-only" ]]; then
842 build_only="true"
843 elif [[ "${1}" = "--with-dependencies" ]]; then
844 deep="--with-dependencies"
845 elif [[ "${1}" = "--into" ]]; then
846 destdir="${2}"
847 shift
848 else
849 die "java-pkg_jar-from called with unknown parameter: ${1}"
850 fi
851 shift
852 done
853
854 local target_pkg="${1}" target_jar="${2}" destjar="${3}"
855
856 [[ -z ${target_pkg} ]] && die "Must specify a package"
857
858 # default destjar to the target jar
859 [[ -z "${destjar}" ]] && destjar="${target_jar}"
860
861 local error_msg="There was a problem getting the classpath for ${target_pkg}."
862 local classpath
863 classpath="$(java-config ${deep} --classpath=${target_pkg})"
864 [[ $? != 0 ]] && die ${error_msg}
865
866 pushd ${destdir} > /dev/null \
867 || die "failed to change directory to ${destdir}"
868
869 # When we have commas this functions is called to bring jars from multiple
870 # packages. This affects recording of dependencencies because that syntax uses :
871 # if we don't change them to : gjl and java-config -d -p break
872 if [[ ${target_pkg} = *,* ]]; then
873 build_only="true"
874 java-pkg_record-jar_ ${target_pkg//,/:}
875 fi
876
877 local jar
878 for jar in ${classpath//:/ }; do
879 local jar_name=$(basename "${jar}")
880 if [[ ! -f "${jar}" ]] ; then
881 debug-print "${jar} from ${target_pkg} does not exist"
882 die "Installation problems with jars in ${target_pkg} - is it installed?"
883 fi
884 # If no specific target jar was indicated, link it
885 if [[ -z "${target_jar}" ]] ; then
886 [[ -f "${target_jar}" ]] && rm "${target_jar}"
887 ln -snf "${jar}" \
888 || die "Failed to make symlink from ${jar} to ${jar_name}"
889 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${target_pkg}" "${jar}"
890 # otherwise, if the current jar is the target jar, link it
891 elif [[ "${jar_name}" == "${target_jar}" ]] ; then
892 [[ -f "${destjar}" ]] && rm "${destjar}"
893 ln -snf "${jar}" "${destjar}" \
894 || die "Failed to make symlink from ${jar} to ${destjar}"
895 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${target_pkg}" "${jar}"
896 popd > /dev/null
897 return 0
898 fi
899 done
900 popd > /dev/null
901 # if no target was specified, we're ok
902 if [[ -z "${target_jar}" ]] ; then
903 return 0
904 # otherwise, die bitterly
905 else
906 die "Failed to find ${target_jar:-jar} in ${target_pkg}"
907 fi
908 }
909
910 # ------------------------------------------------------------------------------
911 # @ebuild-function java-pkg_jarfrom
912 #
913 # See java-pkg_jar-from
914 # ------------------------------------------------------------------------------
915 java-pkg_jarfrom() {
916 java-pkg_jar-from "$@"
917 }
918
919 # ------------------------------------------------------------------------------
920 # @ebuild-function java-pkg_getjars
921 #
922 # Get the classpath provided by any number of packages
923 # Among other things, this can be passed to 'javac -classpath' or 'ant -lib'.
924 # The providing packages are recorded as dependencies into package.env DEPEND
925 # line, unless "--build-only" is passed as the very first argument, for jars
926 # that have to be present only at build time and are not needed on runtime
927 # (junit testing etc).
928 #
929 # Example: Get the classpath for xerces-2 and xalan,
930 # java-pkg_getjars xerces-2,xalan
931 # Example Return:
932 # /usr/share/xerces-2/lib/xml-apis.jar:/usr/share/xerces-2/lib/xmlParserAPIs.jar:/usr/share/xalan/lib/xalan.jar
933 #
934 # @param $opt
935 # --build-only - makes the jar(s) not added into package.env DEPEND line.
936 # (assumed automatically when called inside src_test)
937 # --with-dependencies - get jars also from requested package's dependencies
938 # transitively.
939 # @param $1 - list of packages to get jars from
940 # (passed to java-config --classpath)
941 # ------------------------------------------------------------------------------
942 java-pkg_getjars() {
943 debug-print-function ${FUNCNAME} $*
944
945 local build_only=""
946 local deep=""
947
948 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="true"
949
950 while [[ "${1}" == --* ]]; do
951 if [[ "${1}" = "--build-only" ]]; then
952 build_only="true"
953 elif [[ "${1}" = "--with-dependencies" ]]; then
954 deep="--with-dependencies"
955 else
956 die "java-pkg_jar-from called with unknown parameter: ${1}"
957 fi
958 shift
959 done
960
961 [[ ${#} -ne 1 ]] && die "${FUNCNAME} takes only one argument besides --*"
962
963 local classpath pkgs="${1}"
964 jars="$(java-config ${deep} --classpath=${pkgs})"
965 [[ -z "${jars}" ]] && die "java-config --classpath=${pkgs} failed"
966 debug-print "${pkgs}:${jars}"
967
968 if [[ -z "${classpath}" ]]; then
969 classpath="${jars}"
970 else
971 classpath="${classpath}:${jars}"
972 fi
973
974 # Only record jars that aren't build-only
975 if [[ -z "${build_only}" ]]; then
976 oldifs="${IFS}"
977 IFS=","
978 for pkg in ${pkgs}; do
979 java-pkg_record-jar_ "${pkg}"
980 done
981 IFS="${oldifs}"
982 fi
983
984 echo "${classpath}"
985 }
986
987 # ------------------------------------------------------------------------------
988 # @ebuild-function java-pkg_getjar
989 #
990 # Get the filename of a single jar from a package
991 # The providing package is recorded as runtime dependency into package.env
992 # DEPEND line, unless "--build-only" is passed as the very first argument, for
993 # jars that have to be present only at build time and are not needed on runtime
994 # (junit testing etc).
995 #
996 # @example
997 # java-pkg_getjar xerces-2 xml-apis.jar
998 # @example-return
999 # /usr/share/xerces-2/lib/xml-apis.jar
1000 #
1001 # @param $opt
1002 # --build-only - makes the jar not added into package.env DEPEND line.
1003 # @param $1 - package to use
1004 # @param $2 - jar to get
1005 # ------------------------------------------------------------------------------
1006 java-pkg_getjar() {
1007 debug-print-function ${FUNCNAME} $*
1008
1009 local build_only=""
1010
1011 [[ "${EBUILD_PHASE}" == "test" ]] && build_only="true"
1012
1013 while [[ "${1}" == --* ]]; do
1014 if [[ "${1}" = "--build-only" ]]; then
1015 build_only="true"
1016 else
1017 die "java-pkg_jar-from called with unknown parameter: ${1}"
1018 fi
1019 shift
1020 done
1021
1022 [[ ${#} -ne 2 ]] && die "${FUNCNAME} takes only two arguments besides --*"
1023
1024 local pkg="${1}" target_jar="${2}" jar
1025 [[ -z ${pkg} ]] && die "Must specify package to get a jar from"
1026 [[ -z ${target_jar} ]] && die "Must specify jar to get"
1027
1028 local error_msg="Could not find classpath for ${pkg}. Are you sure its installed?"
1029 local classpath
1030 classpath=$(java-config --classpath=${pkg})
1031 [[ $? != 0 ]] && die ${error_msg}
1032
1033 for jar in ${classpath//:/ }; do
1034 if [[ ! -f "${jar}" ]] ; then
1035 die "Installation problem with jar ${jar} in ${pkg} - is it installed?"
1036 fi
1037
1038 if [[ "$(basename ${jar})" == "${target_jar}" ]] ; then
1039 # Only record jars that aren't build-only
1040 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${pkg}" "${jar}"
1041 echo "${jar}"
1042 return 0
1043 fi
1044 done
1045
1046 die "Could not find ${target_jar} in ${pkg}"
1047 return 1
1048 }
1049
1050 # This function reads stdin, and based on that input, figures out how to
1051 # populate jars from the filesystem.
1052 # Need to figure out a good way of making use of this, ie be able to use a
1053 # string that was built instead of stdin
1054 # NOTE: this isn't quite ready for primetime.
1055 #java-pkg_populate-jars() {
1056 # local line
1057 #
1058 # read line
1059 # while [[ -n "${line}" ]]; do
1060 # # Ignore comments
1061 # [[ ${line%%#*} == "" ]] && continue
1062 #
1063 # # get rid of any spaces
1064 # line="${line// /}"
1065 #
1066 # # format: path=jarinfo
1067 # local path=${line%%=*}
1068 # local jarinfo=${line##*=}
1069 #
1070 # # format: jar@package
1071 # local jar=${jarinfo%%@*}.jar
1072 # local package=${jarinfo##*@}
1073 # if [[ -n ${replace_only} ]]; then
1074 # [[ ! -f $path ]] && die "No jar exists at ${path}"
1075 # fi
1076 # if [[ -n ${create_parent} ]]; then
1077 # local parent=$(dirname ${path})
1078 # mkdir -p "${parent}"
1079 # fi
1080 # java-pkg_jar-from "${package}" "${jar}" "${path}"
1081 #
1082 # read line
1083 # done
1084 #}
1085
1086 # ------------------------------------------------------------------------------
1087 # @section-end query
1088 # ------------------------------------------------------------------------------
1089
1090 # ------------------------------------------------------------------------------
1091 # @section-begin helper
1092 # @section-summary Helper functions
1093 #
1094 # Various other functions to use from an ebuild
1095 # ------------------------------------------------------------------------------
1096
1097 # ------------------------------------------------------------------------------
1098 # @ebuild-function java-pkg_need
1099 #
1100 # Adds virtual dependencies, which can optionally be controlled by a USE flag.
1101 # Currently supported virtuals are:
1102 # javamail
1103 # jdbc-stdext
1104 # jaf
1105 # jdbc-rowset
1106 # jms
1107 #
1108 # @param $1 - Optionally indicate that the dependencies are controlled by
1109 # a use flag by specifying '--use' Requires $2.
1110 # @param $2 - USE flag which will enable the dependencies.
1111 # @param $@ - virtual packages to add depenedencies for
1112 # ------------------------------------------------------------------------------
1113 # TODO rewrite to parse a line based declaration file instead -- karltk
1114 #java-pkg_need() {
1115 # debug-print-function ${FUNCNAME} $*
1116 # local useflag
1117 # if [[ ${1} == "--use" ]]; then
1118 # useflag="${2}"
1119 # shift 2
1120 # fi
1121 #
1122 # if [[ -z ${1} ]]; then
1123 # die "Must specify at least one virtual package."
1124 # fi
1125 #
1126 # local depstr newdepstr
1127 #
1128 # for virtual in ${@}; do
1129 # if has ${virtual} ${JAVA_PKG_VNEED}; then
1130 # debug-print "Already registered virtual ${virtual}"
1131 # continue
1132 # fi
1133 # case ${virtual} in
1134 # javamail)
1135 # debug-print "java-pkg_need: adding javamail dependencies"
1136 # newdepstr="|| ( dev-java/gnu-javamail dev-java/sun-javamail-bin )"
1137 # ;;
1138 # jdbc-stdext)
1139 # debug-print "java-pkg_need: adding jdbc-stdext dependencies"
1140 # newdepstr="|| ( >=virtual/jdk-1.4 dev-java/jdbc2-stdext )"
1141 # ;;
1142 # jaf)
1143 # debug-print "java-pkg_need: adding jaf dependencies"
1144 # newdepstr="|| ( dev-java/gnu-jaf dev-java/sun-jaf-bin )"
1145 # ;;
1146 # jdbc-rowset)
1147 # debug-print "java-pkg_need: adding jdbc-rowset dependencies"
1148 # newdepstr="|| ( >=virtual/jdk-1.5 dev-java/sun-jdbc-rowset )"
1149 # ;;
1150 # jms)
1151 # debug-print "java-pkg_need: adding jms dependencies"
1152 # newdepstr="|| ( dev-java/sun-jms dev-java/openjms )"
1153 # ;;
1154 # *)
1155 # die "Invalid virtual: ${virtual}"
1156 # esac
1157 #
1158 # export JAVA_PKG_VNEED="${JAVA_PKG_VNEED} ${virtual}"
1159 #
1160 # if [[ -n ${useflag} ]]; then
1161 # depstr="${depstr} ${useflag}? ( ${newdepstr} )"
1162 # else
1163 # depstr="${depstr} ${newdepstr}"
1164 # fi
1165 # done
1166 #
1167 # [[ -z ${JAVA_PKG_NV_DEPEND} ]] && export JAVA_PKG_NV_DEPEND="${DEPEND}"
1168 # [[ -z ${JAVA_PKG_NV_RDEPEND} ]] && export JAVA_PKG_NV_RDEPEND="${RDEPEND}"
1169 #
1170 # export DEPEND="${DEPEND} ${depstr}"
1171 # export RDEPEND="${RDEPEND} ${depstr}"
1172 #}
1173
1174 # ------------------------------------------------------------------------------
1175 # @ebuild-function java-pkg_find-normal-jars
1176 #
1177 # Find the files with suffix .jar file in the given directory or $WORKDIR
1178 #
1179 # @param $1 - The directory to search for jar files (default: ${WORKDIR})
1180 # ------------------------------------------------------------------------------
1181 java-pkg_find-normal-jars() {
1182 local dir=$1
1183 [[ "${dir}" ]] || dir="${WORKDIR}"
1184 local found
1185 for jar in $(find "${dir}" -name "*.jar" -type f); do
1186 echo "${jar}"
1187 found="true"
1188 done
1189 [[ "${found}" ]]
1190 return $?
1191 }
1192
1193 # ------------------------------------------------------------------------------
1194 # @ebuild-function java-pkg_ensure-no-bundled-jars
1195 #
1196 # Try to locate bundled jar files in ${WORKDIR} and die if found.
1197 # This function should be called after WORKDIR has been populated with symlink
1198 # to system jar files or bundled jars removed.
1199 # ------------------------------------------------------------------------------
1200 java-pkg_ensure-no-bundled-jars() {
1201 debug-print-function ${FUNCNAME} $*
1202
1203 local bundled_jars=$(java-pkg_find-normal-jars)
1204 if [[ -n ${bundled_jars} ]]; then
1205 echo "Bundled jars found:"
1206 local jar
1207 for jar in ${bundled_jars}; do
1208 echo $(pwd)${jar/./}
1209 done
1210 die "Bundled jars found!"
1211 fi
1212 }
1213
1214 # ------------------------------------------------------------------------------
1215 # @internal-function java-pkg_ensure-vm-version-sufficient
1216 #
1217 # Checks if we have a sufficient VM and dies if we don't.
1218 #
1219 # ------------------------------------------------------------------------------
1220 java-pkg_ensure-vm-version-sufficient() {
1221 debug-print-function ${FUNCNAME} $*
1222
1223 if ! java-pkg_is-vm-version-sufficient; then
1224 debug-print "VM is not suffient"
1225 eerror "Current Java VM cannot build this package"
1226 einfo "Please use java-config -S to set the correct one"
1227 die "Active Java VM cannot build this package"
1228 fi
1229 }
1230
1231 # ------------------------------------------------------------------------------
1232 # @internal-function java-pkg_is-vm-version-sufficient
1233 #
1234 # @return zero - VM is sufficient
1235 # @return non-zero - VM is not sufficient
1236 # ------------------------------------------------------------------------------
1237 java-pkg_is-vm-version-sufficient() {
1238 debug-print-function ${FUNCNAME} $*
1239
1240 depend-java-query --is-sufficient "${DEPEND}" > /dev/null
1241 return $?
1242 }
1243
1244 # ------------------------------------------------------------------------------
1245 # @internal-function java-pkg_ensure-vm-version-eq
1246 #
1247 # Die if the current VM is not equal to the argument passed.
1248 #
1249 # @param $@ - Desired VM version to ensure
1250 # ------------------------------------------------------------------------------
1251 java-pkg_ensure-vm-version-eq() {
1252 debug-print-function ${FUNCNAME} $*
1253
1254 if ! java-pkg_is-vm-version-eq $@ ; then
1255 debug-print "VM is not suffient"
1256 eerror "This package requires a Java VM version = $@"
1257 einfo "Please use java-config -S to set the correct one"
1258 die "Active Java VM too old"
1259 fi
1260 }
1261
1262 # ------------------------------------------------------------------------------
1263 # @internal-function java-pkg_is-vm-version-eq
1264 #
1265 # @param $@ - VM version to compare current VM to
1266 # @return zero - VM versions are equal
1267 # @return non-zero - VM version are not equal
1268 # ------------------------------------------------------------------------------
1269 java-pkg_is-vm-version-eq() {
1270 debug-print-function ${FUNCNAME} $*
1271
1272 local needed_version="$@"
1273
1274 [[ -z "${needed_version}" ]] && die "need an argument"
1275
1276 local vm_version="$(java-pkg_get-vm-version)"
1277
1278 vm_version="$(get_version_component_range 1-2 "${vm_version}")"
1279 needed_version="$(get_version_component_range 1-2 "${needed_version}")"
1280
1281 if [[ -z "${vm_version}" ]]; then
1282 debug-print "Could not get JDK version from DEPEND"
1283 return 1
1284 else
1285 if [[ "${vm_version}" == "${needed_version}" ]]; then
1286 debug-print "Detected a JDK(${vm_version}) = ${needed_version}"
1287 return 0
1288 else
1289 debug-print "Detected a JDK(${vm_version}) != ${needed_version}"
1290 return 1
1291 fi
1292 fi
1293 }
1294
1295 # ------------------------------------------------------------------------------
1296 # @internal-function java-pkg_ensure-vm-version-ge
1297 #
1298 # Die if the current VM is not greater than the desired version
1299 #
1300 # @param $@ - VM version to compare current to
1301 # ------------------------------------------------------------------------------
1302 java-pkg_ensure-vm-version-ge() {
1303 debug-print-function ${FUNCNAME} $*
1304
1305 if ! java-pkg_is-vm-version-ge "$@" ; then
1306 debug-print "vm is not suffient"
1307 eerror "This package requires a Java VM version >= $@"
1308 einfo "Please use java-config -S to set the correct one"
1309 die "Active Java VM too old"
1310 fi
1311 }
1312
1313 # ------------------------------------------------------------------------------
1314 # @internal-function java-pkg_is-vm-version-ge
1315 #
1316 # @param $@ - VM version to compare current VM to
1317 # @return zero - current VM version is greater than checked version
1318 # @return non-zero - current VM version is not greater than checked version
1319 # ------------------------------------------------------------------------------
1320 java-pkg_is-vm-version-ge() {
1321 debug-print-function ${FUNCNAME} $*
1322
1323 local needed_version=$@
1324 local vm_version=$(java-pkg_get-vm-version)
1325 if [[ -z "${vm_version}" ]]; then
1326 debug-print "Could not get JDK version from DEPEND"
1327 return 1
1328 else
1329 if version_is_at_least "${needed_version}" "${vm_version}"; then
1330 debug-print "Detected a JDK(${vm_version}) >= ${needed_version}"
1331 return 0
1332 else
1333 debug-print "Detected a JDK(${vm_version}) < ${needed_version}"
1334 return 1
1335 fi
1336 fi
1337 }
1338
1339 java-pkg_set-current-vm() {
1340 export GENTOO_VM=${1}
1341 }
1342
1343 java-pkg_get-current-vm() {
1344 echo ${GENTOO_VM}
1345 }
1346
1347 java-pkg_current-vm-matches() {
1348 hasq $(java-pkg_get-current-vm) ${@}
1349 return $?
1350 }
1351
1352 # ------------------------------------------------------------------------------
1353 # @ebuild-function java-pkg_get-source
1354 #
1355 # Determines what source version should be used, for passing to -source.
1356 # Unless you want to break things you probably shouldn't set _WANT_SOURCE
1357 #
1358 # @return string - Either the lowest possible source, or JAVA_PKG_WANT_SOURCE
1359 # ------------------------------------------------------------------------------
1360 java-pkg_get-source() {
1361 echo ${JAVA_PKG_WANT_SOURCE:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1362 }
1363
1364 # ------------------------------------------------------------------------------
1365 # @ebuild-function java-pkg_get-target
1366 #
1367 # Determines what target version should be used, for passing to -target.
1368 # If you don't care about lower versions, you can set _WANT_TARGET to the
1369 # version of your JDK.
1370 #
1371 # @return string - Either the lowest possible target, or JAVA_PKG_WANT_TARGET
1372 # ------------------------------------------------------------------------------
1373 java-pkg_get-target() {
1374 echo ${JAVA_PKG_WANT_TARGET:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1375 }
1376
1377 java-pkg_get-javac() {
1378 debug-print-function ${FUNCNAME} $*
1379
1380
1381 local compiler="${GENTOO_COMPILER}"
1382
1383 local compiler_executable
1384 if [[ "${compiler}" = "javac" ]]; then
1385 # nothing fancy needs to be done for javac
1386 compiler_executable="javac"
1387 else
1388 # for everything else, try to determine from an env file
1389
1390 local compiler_env="/usr/share/java-config-2/compiler/${compiler}"
1391 if [[ -f ${compiler_env} ]]; then
1392 local old_javac=${JAVAC}
1393 unset JAVAC
1394 # try to get value of JAVAC
1395 compiler_executable="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${JAVAC})"
1396 export JAVAC=${old_javac}
1397
1398 if [[ -z ${compiler_executable} ]]; then
1399 echo "JAVAC is empty or undefined in ${compiler_env}"
1400 return 1
1401 fi
1402
1403 # check that it's executable
1404 if [[ ! -x ${compiler_executable} ]]; then
1405 echo "${compiler_executable} doesn't exist, or isn't executable"
1406 return 1
1407 fi
1408 else
1409 echo "Could not find environment file for ${compiler}"
1410 return 1
1411 fi
1412 fi
1413 echo ${compiler_executable}
1414 }
1415
1416 # ------------------------------------------------------------------------------
1417 # @ebuild-function java-pkg_javac-args
1418 #
1419 # If an ebuild uses javac directly, instead of using ejavac, it should call this
1420 # to know what -source/-target to use.
1421 #
1422 # @return string - arguments to pass to javac, complete with -target and -source
1423 # ------------------------------------------------------------------------------
1424 java-pkg_javac-args() {
1425 debug-print-function ${FUNCNAME} $*
1426
1427 local want_source="$(java-pkg_get-source)"
1428 local want_target="$(java-pkg_get-target)"
1429
1430 local source_str="-source ${want_source}"
1431 local target_str="-target ${want_target}"
1432
1433 debug-print "want source: ${want_source}"
1434 debug-print "want target: ${want_target}"
1435
1436 if [[ -z "${want_source}" || -z "${want_target}" ]]; then
1437 debug-print "could not find valid -source/-target values for javac"
1438 echo "Could not find valid -source/-target values for javac"
1439 return 1
1440 else
1441 if java-pkg_is-vm-version-ge "1.4"; then
1442 echo "${source_str} ${target_str}"
1443 else
1444 echo "${target_str}"
1445 fi
1446 fi
1447 }
1448
1449 # TODO document
1450 java-pkg_get-jni-cflags() {
1451 local flags="-I${JAVA_HOME}/include"
1452
1453 local platform="linux"
1454 use elibc_FreeBSD && platform="freebsd"
1455
1456 # TODO do a check that the directories are valid
1457 flags="${flags} -I${JAVA_HOME}/include/${platform}"
1458
1459 echo ${flags}
1460 }
1461
1462 java-pkg_ensure-gcj() {
1463 if ! built_with_use sys-devel/gcc gcj ; then
1464 ewarn
1465 ewarn "You must build gcc with the gcj support to build with gcj"
1466 ewarn
1467 ebeep 5
1468 die "No GCJ support found!"
1469 fi
1470 }
1471
1472 java-pkg_ensure-test() {
1473 if hasq test ${FEATURES} && ! hasq -test ${FEATURES} \
1474 && hasq test ${IUSE} && ! use test;
1475 then
1476 eerror "You specified FEATURES=test, but USE=test is needed"
1477 eerror "to pull in the additional dependencies for testing"
1478 die "Need USE=test enabled"
1479 fi
1480 }
1481
1482 # ------------------------------------------------------------------------------
1483 # @ebuild-function java-pkg_register-ant-task
1484 #
1485 # Register this package as ant task, so that ant will load it when no specific
1486 # ANT_TASKS are specified. Note that even without this registering, all packages
1487 # specified in ANT_TASKS will be loaded. Mostly used by the actual ant tasks
1488 # packages, but can be also used by other ebuilds that used to symlink their
1489 # .jar into /usr/share/ant-core/lib to get autoloaded, for backwards
1490 # compatibility.
1491 #
1492 # @param --version x.y Register only for ant version x.y (otherwise for any ant
1493 # version). Used by the ant-* packages to prevent loading of mismatched
1494 # ant-core ant tasks after core was updated, before the tasks are updated,
1495 # without a need for blockers.
1496 # @param $1 Name to register as. Defaults to JAVA_PKG_NAME ($PN[-$SLOT])
1497 # ------------------------------------------------------------------------------
1498 java-pkg_register-ant-task() {
1499 local TASKS_DIR="tasks"
1500
1501 # check for --version x.y parameters
1502 while [[ -n "${1}" && -n "${2}" ]]; do
1503 local var="${1#--}"
1504 local val="${2}"
1505 if [[ "${var}" == "version" ]]; then
1506 TASKS_DIR="tasks-${val}"
1507 else
1508 die "Unknown parameter passed to java-pkg_register-ant-tasks: ${1} ${2}"
1509 fi
1510 shift 2
1511 done
1512
1513 local TASK_NAME="${1:-${JAVA_PKG_NAME}}"
1514
1515 dodir /usr/share/ant/${TASKS_DIR}
1516 touch "${D}/usr/share/ant/${TASKS_DIR}/${TASK_NAME}"
1517 }
1518
1519 # ------------------------------------------------------------------------------
1520 # @internal-function java-pkg_ant-tasks-from-deps
1521 #
1522 # Function to determine ANT_TASKS from DEPEND variable for backwards
1523 # compatibility with ebuilds that don't set ANT_TASKS before calling eant() or
1524 # WANT_ANT_TASKS before inheriting java-pkg-2. If the DEPEND string contains
1525 # "dev-java/ant" or "dev-java/ant-tasks", then it returns "all", otherwise
1526 # "none". It's not smart enough to cope with USE flag depends but that shouldn't
1527 # be a problem, the worst it can do is activace all tasks when not needed.
1528 # Note that this is called only with JAVA_PKG_STRICT=1, to find ebuilds with
1529 # insufficient dependencies, otherwise all available tasks are used for
1530 # backwards compatilbility.
1531 #
1532 # @return "all" or "none"
1533 # ------------------------------------------------------------------------------
1534 java-pkg_ant-tasks-from-deps() {
1535 local found_ant found_ant_tasks
1536
1537 for dep in ${DEPEND}
1538 do
1539 local ant="$(awk '/(dev-java\/ant)/ { if (match($1, "(dev-java/ant)((-[0-9])+|$)", m)) print m[1] }' <<< ${dep})"
1540 [[ "${ant}" == "dev-java/ant" ]] && found_ant=true
1541 [[ "${dep}" == *"ant-tasks"* ]] && found_ant_tasks=true
1542 done
1543
1544 if [[ -n "${found_ant}" || -n "${found_ant_tasks}" ]]; then
1545 java-pkg_announce-qa-violation "The ebuild DEPENDS on deprecated ant or ant-tasks"
1546 echo "all"
1547 else
1548 # ebuild doesn't set ANT_TASKS and doesn't depend on ant-tasks or ant
1549 # so we deactivate all tasks that may be installed
1550 echo "none"
1551 fi
1552 }
1553
1554 # ------------------------------------------------------------------------------
1555 # @internal-function java-pkg_ant-tasks-depend
1556 #
1557 # Translates the WANT_ANT_TASKS variable into valid dependencies.
1558 # ------------------------------------------------------------------------------
1559 java-pkg_ant-tasks-depend() {
1560 debug-print-function ${FUNCNAME} ${WANT_ANT_TASKS}
1561
1562 if [[ -n "${WANT_ANT_TASKS}" ]]; then
1563 local DEP=""
1564 for i in ${WANT_ANT_TASKS}
1565 do
1566 if [[ ${i} != ant-* ]]; then
1567 echo "Invalid atom in WANT_ANT_TASKS: ${i}"
1568 return 1
1569 fi
1570 DEP="${DEP}dev-java/${i} "
1571 done
1572 echo ${DEP}
1573 return 0
1574 else
1575 return 0
1576 fi
1577 }
1578
1579 # ------------------------------------------------------------------------------
1580 # @section-end helper
1581 # ------------------------------------------------------------------------------
1582
1583 # ------------------------------------------------------------------------------
1584 # @section-begin build
1585 # @section-summary Build functions
1586 #
1587 # These are some functions for building a package. In particular, it consists of
1588 # wrappers for javac and ant.
1589 # ------------------------------------------------------------------------------
1590
1591 # ------------------------------------------------------------------------------
1592 # @ebuild-function eant
1593 #
1594 # Ant wrapper function. Will use the appropriate compiler, based on user-defined
1595 # compiler. Will also set proper ANT_TASKS from the variable ANT_TASKS,
1596 # variables:
1597 # EANT_GENTOO_CLASSPATH - calls java-pkg_getjars for the value and adds to the
1598 # gentoo.classpath property. Be sure to call
1599 # java-ant_rewrite-classpath in src_unpack.
1600 # *ANT_TASKS - used to determine ANT_TASKS before calling Ant.
1601 # ------------------------------------------------------------------------------
1602 eant() {
1603 debug-print-function ${FUNCNAME} $*
1604
1605 # FIXME get this working
1606 # if is-java-strict && [[ ! ${DEPEND} =~ "dev-java/ant" ]]; then
1607 # java-pkg_announce-qa-violation \
1608 # "Using eant, but not depending on dev-java/ant or dev-java/ant-core"
1609 # fi
1610
1611 if ! hasq java-ant-2 ${INHERITED} && is-java-strict; then
1612 local msg="You should inherit java-ant-2 when using eant"
1613 java-pkg_announce-qa-violation ${msg}
1614 die ${msg}
1615 fi
1616
1617 local antflags="-Dnoget=true -Dmaven.mode.offline=true"
1618
1619 java-pkg_init-compiler_
1620 local compiler="${GENTOO_COMPILER}"
1621
1622 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1623
1624 local build_compiler="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER})"
1625 if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then
1626 die "ANT_BUILD_COMPILER undefined in ${compiler_env}"
1627 fi
1628
1629 if [[ ${compiler} != "javac" ]]; then
1630 antflags="${antflags} -Dbuild.compiler=${build_compiler}"
1631 # Figure out any extra stuff to put on the classpath for compilers aside
1632 # from javac
1633 # ANT_BUILD_COMPILER_DEPS should be something that could be passed to
1634 # java-config -p
1635 local build_compiler_deps="$(source ${JAVA_PKG_COMPILER_DIR}/${compiler} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER_DEPS})"
1636 if [[ -n ${build_compiler_deps} ]]; then
1637 antflags="${antflags} -lib $(java-config -p ${build_compiler_deps})"
1638 fi
1639 fi
1640
1641 if is-java-strict; then
1642 einfo "Disabling system classpath for ant"
1643 antflags="${antflags} -Dbuild.sysclasspath=ignore"
1644 fi
1645
1646 for arg in "${@}"; do
1647 if [[ ${arg} = -lib ]]; then
1648 if is-java-strict; then
1649 eerror "You should not use the -lib argument to eant because it will fail"
1650 eerror "with JAVA_PKG_STRICT. Please use for example java-pkg_jar-from"
1651 eerror "or ant properties to make dependencies available."
1652 eerror "For ant tasks use WANT_ANT_TASKS or ANT_TASKS from."
1653 eerror "split ant (>=dev-java/ant-core-1.7)."
1654 die "eant -lib is deprecated/forbidden"
1655 else
1656 echo "eant -lib is deprecated. Turn JAVA_PKG_STRICT on for"
1657 echo "more info."
1658 fi
1659 fi
1660 done
1661
1662 if has_version ">=dev-java/ant-core-1.7.0"; then
1663 # default ANT_TASKS to WANT_ANT_TASKS, if ANT_TASKS is not set explicitly
1664 ANT_TASKS="${ANT_TASKS:-${WANT_ANT_TASKS}}"
1665
1666 # override ANT_TASKS with JAVA_PKG_FORCE_ANT_TASKS if it's set
1667 ANT_TASKS="${JAVA_PKG_FORCE_ANT_TASKS:-${ANT_TASKS}}"
1668
1669 if is-java-strict; then
1670 # if ant-tasks were not set by ebuild or forced, try to determine them from depends
1671 if [[ -z "${ANT_TASKS}" ]]; then
1672 ANT_TASKS="$(java-pkg_ant-tasks-from-deps)"
1673 fi
1674 else
1675 # if ant-tasks is not set by ebuild or forced, activate all of them
1676 ANT_TASKS="${ANT_TASKS:-all}"
1677 fi
1678
1679 # at this point, ANT_TASKS should be "all", "none" or explicit list
1680 if [[ "${ANT_TASKS}" == "all" ]]; then
1681 einfo "Using all available ANT_TASKS"
1682 elif [[ "${ANT_TASKS}" == "none" ]]; then
1683 einfo "Disabling all optional ANT_TASKS"
1684 else
1685 einfo "Using following ANT_TASKS: ${ANT_TASKS}"
1686 fi
1687
1688 export ANT_TASKS
1689 fi
1690
1691 [[ -n ${JAVA_PKG_DEBUG} ]] && antflags="${antflags} --execdebug -debug"
1692 [[ -n ${PORTAGE_QUIET} ]] && antflags="${antflags} -q"
1693
1694 local gcp="${EANT_GENTOO_CLASSPATH}"
1695
1696 if [[ ${EBUILD_PHASE} = "test" ]]; then
1697 antflags="${antflags} -DJunit.present=true"
1698 [[ ${gcp} && ${ANT_TASKS} = *ant-junit* ]] && gcp="${gcp} junit"
1699 fi
1700
1701 local cp
1702
1703 for atom in ${gcp}; do
1704 cp="${cp}:$(java-pkg_getjars ${atom})"
1705 done
1706
1707 if [[ ${cp} ]]; then
1708 # It seems ant does not like single quotes around ${cp}
1709 antflags="${antflags} -Dgentoo.classpath=\"${cp#:}\""
1710 fi
1711
1712 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}"
1713 debug-print "Calling ant: ${antflags} ${@}"
1714 ant ${antflags} "${@}" || die "eant failed"
1715
1716 }
1717
1718 # ------------------------------------------------------------------------------
1719 # @ebuild-function ejavac
1720 #
1721 # Javac wrapper function. Will use the appropriate compiler, based on
1722 # /etc/java-config/compilers.conf
1723 #
1724 # @param $@ - Arguments to be passed to the compiler
1725 # ------------------------------------------------------------------------------
1726 ejavac() {
1727 debug-print-function ${FUNCNAME} $*
1728
1729 java-pkg_init-compiler_
1730
1731 local compiler_executable
1732 compiler_executable=$(java-pkg_get-javac)
1733 if [[ ${?} != 0 ]]; then
1734 eerror "There was a problem determining compiler: ${compiler_executable}"
1735 die "get-javac failed"
1736 fi
1737
1738 local javac_args
1739 javac_args="$(java-pkg_javac-args)"
1740 if [[ ${?} != 0 ]]; then
1741 eerror "There was a problem determining JAVACFLAGS: ${javac_args}"
1742 die "java-pkg_javac-args failed"
1743 fi
1744
1745 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} ${javac_args} "${@}"
1746 ${compiler_executable} ${javac_args} "${@}" || die "ejavac failed"
1747 }
1748
1749 # ------------------------------------------------------------------------------
1750 # @ebuild-function java-pkg_filter-compiler
1751 #
1752 # Used to prevent the use of some compilers. Should be used in src_compile.
1753 # Basically, it just appends onto JAVA_PKG_FILTER_COMPILER
1754 #
1755 # @param $@ - compilers to filter
1756 # ------------------------------------------------------------------------------
1757 java-pkg_filter-compiler() {
1758 JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@"
1759 }
1760
1761 # ------------------------------------------------------------------------------
1762 # @ebuild-function java-pkg_force-compiler
1763 #
1764 # Used to force the use of particular compilers. Should be used in src_compile.
1765 # A common use of this would be to force ecj-3.1 to be used on amd64, to avoid
1766 # OutOfMemoryErrors that may come up.
1767 #
1768 # @param $@ - compilers to force
1769 # ------------------------------------------------------------------------------
1770 java-pkg_force-compiler() {
1771 JAVA_PKG_FORCE_COMPILER="$@"
1772 }
1773
1774 # ------------------------------------------------------------------------------
1775 # @ebuild-function use_doc
1776 #
1777 # Helper function for getting ant to build javadocs. If the user has USE=doc,
1778 # then 'javadoc' or the argument are returned. Otherwise, there is no return.
1779 #
1780 # The output of this should be passed to ant.
1781 #
1782 # Example: build javadocs by calling 'javadoc' target
1783 # eant $(use_doc)
1784 # Example: build javadocs by calling 'apidoc' target
1785 # eant $(use_doc apidoc)
1786 #
1787 # @param $@ - Option value to return. Defaults to 'javadoc'
1788 # @return string - Name of the target to create javadocs
1789 # ------------------------------------------------------------------------------
1790 use_doc() {
1791 use doc && echo ${@:-javadoc}
1792 }
1793
1794
1795 # ------------------------------------------------------------------------------
1796 # @section-end build
1797 # ------------------------------------------------------------------------------
1798
1799 # ------------------------------------------------------------------------------
1800 # @section-begin internal
1801 # @section-summary Internal functions
1802 #
1803 # Do __NOT__ use any of these from an ebuild! These are only to be used from
1804 # within the java eclasses.
1805 # ------------------------------------------------------------------------------
1806
1807 # -----------------------------------------------------------------------------
1808 # @function-internal java-pkg_init
1809 #
1810 # The purpose of this function, as the name might imply, is to initialize the
1811 # Java environment. It ensures that that there aren't any environment variables
1812 # that'll muss things up. It initializes some variables, which are used
1813 # internally. And most importantly, it'll switch the VM if necessary.
1814 #
1815 # This shouldn't be used directly. Instead, java-pkg and java-pkg-opt will
1816 # call it during each of the phases of the merge process.
1817 #
1818 # -----------------------------------------------------------------------------
1819 java-pkg_init() {
1820 unset JAVAC
1821 unset JAVA_HOME
1822
1823 # People do all kinds of weird things.
1824 # http://forums.gentoo.org/viewtopic-p-3943166.html
1825 local silence="${SILENCE_JAVA_OPTIONS_WARNING}"
1826 local accept="${I_WANT_GLOBAL_JAVA_OPTIONS}"
1827 if [[ -n ${_JAVA_OPTIONS} && -z ${accept} && -z ${silence} ]]; then
1828 ewarn "_JAVA_OPTIONS changes what java -version outputs at least for"
1829 ewarn "sun-jdk vms and and as such break configure scripts that"
1830 ewarn "use it (for example app-office/openoffice) so we filter it out."
1831 ewarn "Use SILENCE_JAVA_OPTIONS_WARNING=true in the environment (use"
1832 ewarn "make.conf for example) to silence this warning or"
1833 ewarn "I_WANT_GLOBAL_JAVA_OPTIONS to not filter it."
1834 fi
1835
1836 if [[ -z ${accept} ]]; then
1837 unset _JAVA_OPTIONS
1838 # phase hooks make this run many times without this
1839 I_WANT_GLOBAL_JAVA_OPTIONS="true"
1840 fi
1841
1842 java-pkg_init_paths_
1843 java-pkg_switch-vm
1844 PATH=${JAVA_HOME}/bin:${PATH}
1845
1846 # TODO we will probably want to set JAVAC and JAVACFLAGS
1847
1848 # Do some QA checks
1849 java-pkg_check-jikes
1850
1851 # When users have crazy classpaths some packages can fail to compile.
1852 # and everything should work with empty CLASSPATH.
1853 # This also helps prevent unexpected dependencies on random things
1854 # from the CLASSPATH.
1855 unset CLASSPATH
1856
1857 # Unset external ANT_ stuff
1858 unset ANT_TASKS
1859 unset ANT_OPTS
1860 }
1861
1862 # ------------------------------------------------------------------------------
1863 # @function-internal java-pkg-init-compiler_
1864 #
1865 # This function attempts to figure out what compiler should be used. It does
1866 # this by reading the file at JAVA_PKG_COMPILERS_CONF, and checking the
1867 # COMPILERS variable defined there.
1868 # This can be overridden by a list in JAVA_PKG_FORCE_COMPILER
1869 #
1870 # It will go through the list of compilers, and verify that it supports the
1871 # target and source that are needed. If it is not suitable, then the next
1872 # compiler is checked. When JAVA_PKG_FORCE_COMPILER is defined, this checking
1873 # isn't done.
1874 #
1875 # Once the which compiler to use has been figured out, it is set to
1876 # GENTOO_COMPILER.
1877 #
1878 # If you hadn't guessed, JAVA_PKG_FORCE_COMPILER is for testing only.
1879 #
1880 # If the user doesn't defined anything in JAVA_PKG_COMPILERS_CONF, or no
1881 # suitable compiler was found there, then the default is to use javac provided
1882 # by the current VM.
1883 #
1884 #
1885 # @return name of the compiler to use
1886 # ------------------------------------------------------------------------------
1887 java-pkg_init-compiler_() {
1888 debug-print-function ${FUNCNAME} $*
1889
1890 if [[ -n ${GENTOO_COMPILER} ]]; then
1891 debug-print "GENTOO_COMPILER already set"
1892 return
1893 fi
1894
1895 local compilers;
1896 if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
1897 compilers="$(source ${JAVA_PKG_COMPILERS_CONF} 1>/dev/null 2>&1; echo ${COMPILERS})"
1898 else
1899 compilers=${JAVA_PKG_FORCE_COMPILER}
1900 fi
1901
1902 debug-print "Read \"${compilers}\" from ${JAVA_PKG_COMPILERS_CONF}"
1903
1904 # Figure out if we should announce what compiler we're using
1905 local compiler
1906 for compiler in ${compilers}; do
1907 debug-print "Checking ${compiler}..."
1908 # javac should always be alright
1909 if [[ ${compiler} = "javac" ]]; then
1910 debug-print "Found javac... breaking"
1911 export GENTOO_COMPILER="javac"
1912 break
1913 fi
1914
1915 if has ${compiler} ${JAVA_PKG_FILTER_COMPILER}; then
1916 if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
1917 einfo "Filtering ${compiler}"
1918 continue
1919 fi
1920 fi
1921
1922 # for non-javac, we need to make sure it supports the right target and
1923 # source
1924 local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1925 if [[ -f ${compiler_env} ]]; then
1926 local desired_target="$(java-pkg_get-target)"
1927 local desired_source="$(java-pkg_get-source)"
1928
1929
1930 # Verify that the compiler supports target
1931 local supported_target=$(source ${compiler_env} 1>/dev/null 2>&1; echo ${SUPPORTED_TARGET})
1932 if ! has ${desired_target} ${supported_target}; then
1933 ewarn "${compiler} does not support -target ${desired_target}, skipping"
1934 continue
1935 fi
1936
1937 # -source was introduced in 1.3, so only check 1.3 and on
1938 if version_is_at_least "${desired_soure}" "1.3"; then
1939 # Verify that the compiler supports source
1940 local supported_source=$(source ${compiler_env} 1>/dev/null 2>&1; echo ${SUPPORTED_SOURCE})
1941 if ! has ${desired_source} ${supported_source}; then
1942 ewarn "${compiler} does not support -source ${desired_source}, skipping"
1943 continue
1944 fi
1945 fi
1946
1947 # if you get here, then the compiler should be good to go
1948 export GENTOO_COMPILER="${compiler}"
1949 break
1950 else
1951 ewarn "Could not find configuration for ${compiler}, skipping"
1952 ewarn "Perhaps it is not installed?"
1953 continue
1954 fi
1955 done
1956
1957 # If it hasn't been defined already, default to javac
1958 if [[ -z ${GENTOO_COMPILER} ]]; then
1959 if [[ -n ${compilers} ]]; then
1960 einfo "No suitable compiler found: defaulting javac for compilation"
1961 else
1962 # probably don't need to notify users about the default.
1963 :;#einfo "Defaulting to javac for compilation"
1964 fi
1965 export GENTOO_COMPILER=javac
1966 else
1967 einfo "Using ${GENTOO_COMPILER} for compilation"
1968 fi
1969
1970 }
1971
1972 # ------------------------------------------------------------------------------
1973 # @internal-function init_paths_
1974 #
1975 # Initializes some variables that will be used. These variables are mostly used
1976 # to determine where things will eventually get installed.
1977 # ------------------------------------------------------------------------------
1978 java-pkg_init_paths_() {
1979 debug-print-function ${FUNCNAME} $*
1980
1981 local pkg_name
1982 if [[ "$SLOT" == "0" ]] ; then
1983 JAVA_PKG_NAME="${PN}"
1984 else
1985 JAVA_PKG_NAME="${PN}-${SLOT}"
1986 fi
1987
1988 JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}"
1989 JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/"
1990 JAVA_PKG_ENV="${D}${JAVA_PKG_SHAREPATH}/package.env"
1991
1992 [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib"
1993 [[ -z "${JAVA_PKG_LIBDEST}" ]] && JAVA_PKG_LIBDEST="${DESTTREE}/$(get_libdir)/${JAVA_PKG_NAME}"
1994 [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps"
1995
1996
1997 # TODO maybe only print once?
1998 debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}"
1999 debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}"
2000 debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}"
2001 debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}"
2002 debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}"
2003 }
2004
2005 # ------------------------------------------------------------------------------
2006 # @internal-function java-pkg_do_write_
2007 #
2008 # Writes the package.env out to disk.
2009 #
2010 # ------------------------------------------------------------------------------
2011 # TODO change to do-write, to match everything else
2012 java-pkg_do_write_() {
2013 java-pkg_init_paths_
2014 # Create directory for package.env
2015 dodir "${JAVA_PKG_SHAREPATH}"
2016 if [[ -n "${JAVA_PKG_CLASSPATH}" || -n "${JAVA_PKG_LIBRARY}" || -f "${JAVA_PKG_DEPEND}" ]]; then
2017 # Create package.env
2018 (
2019 echo "DESCRIPTION=\"${DESCRIPTION}\""
2020 echo "GENERATION=\"2\""
2021
2022 [[ -n "${JAVA_PKG_CLASSPATH}" ]] && echo "CLASSPATH=\"${JAVA_PKG_CLASSPATH}\""
2023 [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\""
2024 [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\""
2025 [[ -f "${JAVA_PKG_DEPEND}" ]] && echo "DEPEND=\"$(cat ${JAVA_PKG_DEPEND} | uniq | tr '\n' ':')\""
2026 echo "VM=\"$(echo ${RDEPEND} ${DEPEND} | sed -e 's/ /\n/g' | sed -n -e '/virtual\/\(jre\|jdk\)/ { p;q }')\"" # TODO cleanup !
2027 ) > "${JAVA_PKG_ENV}"
2028
2029 # register target/source
2030 local target="$(java-pkg_get-target)"
2031 local source="$(java-pkg_get-source)"
2032 [[ -n ${target} ]] && echo "TARGET=\"${target}\"" >> "${JAVA_PKG_ENV}"
2033 [[ -n ${source} ]] && echo "SOURCE=\"${source}\"" >> "${JAVA_PKG_ENV}"
2034
2035 # register javadoc info
2036 [[ -n ${JAVADOC_PATH} ]] && echo "JAVADOC_PATH=\"${JAVADOC_PATH}\"" \
2037 >> ${JAVA_PKG_ENV}
2038 # register source archives
2039 [[ -n ${JAVA_SOURCES} ]] && echo "JAVA_SOURCES=\"${JAVA_SOURCES}\"" \
2040 >> ${JAVA_PKG_ENV}
2041
2042
2043 echo "MERGE_VM=\"${GENTOO_VM}\"" >> "${JAVA_PKG_ENV}"
2044 [[ -n ${GENTOO_COMPILER} ]] && echo "MERGE_COMPILER=\"${GENTOO_COMPILER}\"" >> "${JAVA_PKG_ENV}"
2045
2046 # Strip unnecessary leading and trailing colons
2047 # TODO try to cleanup if possible
2048 sed -e "s/=\":/=\"/" -e "s/:\"$/\"/" -i "${JAVA_PKG_ENV}" || die "Did you forget to call java_init ?"
2049 fi
2050 }
2051
2052 # ------------------------------------------------------------------------------
2053 # @internal-function java-pkg_record-jar_
2054 #
2055 # Record a dependency to the package.env
2056 #
2057 # ------------------------------------------------------------------------------
2058 JAVA_PKG_DEPEND="${T}/java-pkg-depend"
2059
2060 java-pkg_record-jar_() {
2061 debug-print-function ${FUNCNAME} $*
2062
2063 local pkg=${1} jar=${2} append
2064 if [[ -z "${jar}" ]]; then
2065 append="${pkg}"
2066 else
2067 append="$(basename ${jar})@${pkg}"
2068 fi
2069
2070 echo ${append} >> ${JAVA_PKG_DEPEND}
2071 }
2072
2073 # ------------------------------------------------------------------------------
2074 # @internal-function java-pkg_append_
2075 #
2076 # Appends a value to a variable
2077 #
2078 # Example: java-pkg_append_ CLASSPATH foo.jar
2079 # @param $1 variable name to modify
2080 # @param $2 value to append
2081 # ------------------------------------------------------------------------------
2082 java-pkg_append_() {
2083 debug-print-function ${FUNCNAME} $*
2084
2085 local var="${1}" value="${2}"
2086 if [[ -z "${!var}" ]] ; then
2087 export ${var}="${value}"
2088 else
2089 local oldIFS=${IFS} cur haveit
2090 IFS=':'
2091 for cur in ${!var}; do
2092 if [[ ${cur} == ${value} ]]; then
2093 haveit="yes"
2094 break
2095 fi
2096 done
2097 [[ -z ${haveit} ]] && export ${var}="${!var}:${value}"
2098 IFS=${oldIFS}
2099 fi
2100 }
2101
2102 # ------------------------------------------------------------------------------
2103 # @internal-function java-pkg_expand_dir_
2104 #
2105 # Gets the full path of the file/directory's parent.
2106 # @param $1 - file/directory to find parent directory for
2107 # @return - path to $1's parent directory
2108 # ------------------------------------------------------------------------------
2109 java-pkg_expand_dir_() {
2110 pushd "$(dirname "${1}")" >/dev/null 2>&1
2111 pwd
2112 popd >/dev/null 2>&1
2113 }
2114
2115 # ------------------------------------------------------------------------------
2116 # @internal-function java-pkg_func-exists
2117 #
2118 # Does the indicated function exist?
2119 #
2120 # @return 0 - function is declared
2121 # @return 1 - function is undeclared
2122 # ------------------------------------------------------------------------------
2123 java-pkg_func-exists() {
2124 if [[ -n "$(declare -f ${1})" ]]; then
2125 return 0
2126 else
2127 return 1
2128 fi
2129 }
2130
2131 # ------------------------------------------------------------------------------
2132 # @internal-function java-pkg_setup-vm
2133 #
2134 # Sets up the environment for a specific VM
2135 #
2136 # ------------------------------------------------------------------------------
2137 java-pkg_setup-vm() {
2138 debug-print-function ${FUNCNAME} $*
2139
2140 local vendor="$(java-pkg_get-vm-vendor)"
2141 if [[ "${vendor}" == "sun" ]] && java-pkg_is-vm-version-ge "1.5" ; then
2142 addpredict "/dev/random"
2143 elif [[ "${vendor}" == "ibm" ]]; then
2144 addpredict "/proc/self/maps"
2145 addpredict "/proc/cpuinfo"
2146 export LANG="C" LC_ALL="C"
2147 elif [[ "${vendor}" == "jrockit" ]]; then
2148 addpredict "/proc/cpuinfo"
2149 fi
2150 }
2151
2152 # ------------------------------------------------------------------------------
2153 # @internal-function java-pkg_needs-vm
2154 #
2155 # Does the current package depend on virtual/jdk?
2156 #
2157 # @return 0 - Package depends on virtual/jdk
2158 # @return 1 - Package does not depend on virtual/jdk
2159 # ------------------------------------------------------------------------------
2160 java-pkg_needs-vm() {
2161 debug-print-function ${FUNCNAME} $*
2162
2163 if [[ -n "$(echo ${DEPEND} | sed -e '\:virtual/jdk:!d')" ]]; then
2164 return 0
2165 fi
2166
2167 return 1
2168 }
2169
2170 # ------------------------------------------------------------------------------
2171 # @internal-function java-pkg_get-current-vm
2172 #
2173 # @return - The current VM being used
2174 # ------------------------------------------------------------------------------
2175 java-pkg_get-current-vm() {
2176 java-config -f
2177 }
2178
2179 # ------------------------------------------------------------------------------
2180 # @internal-function java-pkg_get-vm-vendor
2181 #
2182 # @return - The vendor of the current VM
2183 # ------------------------------------------------------------------------------
2184 java-pkg_get-vm-vendor() {
2185 debug-print-function ${FUNCNAME} $*
2186
2187 local vm="$(java-pkg_get-current-vm)"
2188 vm="${vm/-*/}"
2189 echo "${vm}"
2190 }
2191
2192 # ------------------------------------------------------------------------------
2193 # @internal-function java-pkg_get-vm-version
2194 #
2195 # @return - The version of the current VM
2196 # ------------------------------------------------------------------------------
2197 java-pkg_get-vm-version() {
2198 debug-print-function ${FUNCNAME} $*
2199
2200 java-config -g PROVIDES_VERSION
2201 }
2202
2203 # ------------------------------------------------------------------------------
2204 # @internal-function java-pkg_switch-vm
2205 #
2206 # Switch VM if we're allowed to (controlled by JAVA_PKG_ALLOW_VM_CHANGE), and
2207 # verify that the current VM is sufficient.
2208 # Setup the environment for the VM being used.
2209 # ------------------------------------------------------------------------------
2210 java-pkg_switch-vm() {
2211 debug-print-function ${FUNCNAME} $*
2212
2213 if java-pkg_needs-vm; then
2214 # Use the VM specified by JAVA_PKG_FORCE_VM
2215 if [[ -n "${JAVA_PKG_FORCE_VM}" ]]; then
2216 # If you're forcing the VM, I hope you know what your doing...
2217 debug-print "JAVA_PKG_FORCE_VM used: ${JAVA_PKG_FORCE_VM}"
2218 export GENTOO_VM="${JAVA_PKG_FORCE_VM}"
2219 # if we're allowed to switch the vm...
2220 elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then
2221 debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}} VNEED: ${JAVA_PKG_VNEED}"
2222 if [[ -n ${JAVA_PKG_VNEED} ]]; then
2223 GENTOO_VM="$(depend-java-query --need-virtual "${JAVA_PKG_VNEED}" --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")"
2224 else
2225 GENTOO_VM="$(depend-java-query --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")"
2226 fi
2227 if [[ -z "${GENTOO_VM}" || "${GENTOO_VM}" == "None" ]]; then
2228 eerror "Unable to determine VM for building from dependencies:"
2229 echo "NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}}"
2230 echo "VNEED: ${JAVA_PKG_VNEED}"
2231 die "Failed to determine VM for building."
2232 else
2233 export GENTOO_VM
2234 fi
2235 # otherwise just make sure the current VM is sufficient
2236 else
2237 java-pkg_ensure-vm-version-sufficient
2238 fi
2239 debug-print "Using: $(java-config -f)"
2240
2241 java-pkg_setup-vm
2242
2243 export JAVA=$(java-config --java)
2244 export JAVAC=$(java-config --javac)
2245 JAVACFLAGS="$(java-pkg_javac-args)"
2246 if [[ ${?} != 0 ]]; then
2247 eerror "There was a problem determining JAVACFLAGS: ${JAVACFLAGS}"
2248 die "java-pkg_javac-args failed"
2249 fi
2250 [[ -n ${JAVACFLAGS_EXTRA} ]] && JAVACFLAGS="${JAVACFLAGS_EXTRA} ${JAVACFLAGS}"
2251 export JAVACFLAGS
2252
2253 export JAVA_HOME="$(java-config -g JAVA_HOME)"
2254 export JDK_HOME=${JAVA_HOME}
2255
2256 #TODO If you know a better solution let us know.
2257 java-pkg_append_ LD_LIBRARY_PATH "$(java-config -g LDPATH)"
2258
2259 local tann="${T}/announced-vm"
2260 if [[ -n "${JAVA_PKG_DEBUG}" ]] || [[ ! -f "${tann}" ]] ; then
2261 # Add a check for setup/preinst phase... to avoid duplicate outputs
2262 # for when FEATURES=buildpkg
2263 if [[ ${EBUILD_PHASE} != "setup" && ${EBUILD_PHASE} != "preinst" && ${EBUILD_PHASE} != "postinst" ]];
2264 then
2265 einfo "Using: $(java-config -f)"
2266 [[ ! -f "${tann}" ]] && touch "${tann}"
2267 fi
2268 fi
2269
2270 else
2271 [[ -n "${JAVA_PKG_DEBUG}" ]] && ewarn "!!! This package inherits java-pkg but doesn't depend on a JDK. -bin or broken dependency!!!"
2272 fi
2273 }
2274
2275 # ------------------------------------------------------------------------------
2276 # @internal-function java-pkg_die
2277 #
2278 # Enhanced die for Java packages, which displays some information that may be
2279 # useful for debugging bugs on bugzilla.
2280 # ------------------------------------------------------------------------------
2281 #register_die_hook java-pkg_die
2282 if ! hasq java-pkg_die ${EBUILD_DEATH_HOOKS}; then
2283 EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die"
2284 fi
2285
2286 java-pkg_die() {
2287 echo "!!! When you file a bug report, please include the following information:" >&2
2288 echo "GENTOO_VM=${GENTOO_VM} CLASSPATH=\"${CLASSPATH}\" JAVA_HOME=\"${JAVA_HOME}\"" >&2
2289 echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2
2290 echo "and of course, the output of emerge --info" >&2
2291 }
2292
2293
2294 # TODO document
2295 # List jars in the source directory, ${S}
2296 java-pkg_jar-list() {
2297 if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
2298 einfo "Linked Jars"
2299 find "${S}" -type l -name '*.jar' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2300 einfo "Jars"
2301 find "${S}" -type f -name '*.jar' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2302 einfo "Classes"
2303 find "${S}" -type f -name '*.class' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
2304 fi
2305 }
2306
2307 # ------------------------------------------------------------------------------
2308 # @internal-function java-pkg_verify-classes
2309 #
2310 # Verify that the classes were compiled for the right source / target. Dies if
2311 # not.
2312 # @param $1 (optional) - the file to check, otherwise checks whole ${D}
2313 # ------------------------------------------------------------------------------
2314 java-pkg_verify-classes() {
2315 #$(find ${D} -type f -name '*.jar' -o -name '*.class')
2316 local target=$(java-pkg_get-target)
2317 local result
2318 local log="${T}/class-version-verify.log"
2319 if [[ -n "${1}" ]]; then
2320 class-version-verify.py -v -t ${target} "${1}" > "${log}"
2321 result=$?
2322 else
2323 ebegin "Verifying java class versions (target: ${target})"
2324 class-version-verify.py -v -t ${target} -r "${D}" > "${log}"
2325 result=$?
2326 eend ${result}
2327 fi
2328 [[ -n ${JAVA_PKG_DEBUG} ]] && cat "${log}"
2329 if [[ ${result} != 0 ]]; then
2330 eerror "Incorrect bytecode version found"
2331 [[ -n "${1}" ]] && eerror "in file: ${1}"
2332 eerror "See ${log} for more details."
2333 die "Incorrect bytecode found"
2334 fi
2335 }
2336
2337 # ------------------------------------------------------------------------------
2338 # @section-end internal
2339 # ------------------------------------------------------------------------------
2340
2341 java-pkg_check-phase() {
2342 local phase=${1}
2343 local funcname=${2}
2344 if is-java-strict && [[ ${EBUILD_PHASE} != ${phase} ]]; then
2345 java-pkg_announce-qa-violation \
2346 "${funcname} used outside of src_${phase}"
2347 fi
2348 }
2349
2350 java-pkg_check-versioned-jar() {
2351 local jar=${1}
2352
2353 if [[ ${jar} =~ ${PV} ]]; then
2354 java-pkg_announce-qa-violation "installing versioned jar '${jar}'"
2355 fi
2356 }
2357
2358 java-pkg_check-jikes() {
2359 if hasq jikes ${IUSE}; then
2360 java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE"
2361 fi
2362 }
2363
2364 java-pkg_announce-qa-violation() {
2365 if is-java-strict; then
2366 echo "Java QA Notice: $@" >&2
2367 increment-qa-violations
2368 fi
2369 }
2370
2371 increment-qa-violations() {
2372 let "JAVA_PKG_QA_VIOLATIONS+=1"
2373 export JAVA_PKG_QA_VIOLATIONS
2374 }
2375
2376 is-java-strict() {
2377 [[ -n ${JAVA_PKG_STRICT} ]]
2378 return $?
2379 }
2380
2381 # ------------------------------------------------------------------------------
2382 # @eclass-end
2383 # ------------------------------------------------------------------------------

  ViewVC Help
Powered by ViewVC 1.1.20