/[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.68 - (show annotations) (download)
Sun Mar 25 10:02:09 2007 UTC (7 years, 5 months ago) by betelgeuse
Branch: MAIN
Changes since 1.67: +6 -1 lines
Added instructions on how to fix an error when calling regjar with *.jar but not using ${D}.

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

  ViewVC Help
Powered by ViewVC 1.1.20