/[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.66 - (show annotations) (download)
Sat Mar 17 13:26:12 2007 UTC (7 years, 5 months ago) by betelgeuse
Branch: MAIN
Changes since 1.65: +12 -4 lines
Check that app-arch/zip is in DEPEND in java-pkg_dosrc.

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

  ViewVC Help
Powered by ViewVC 1.1.20