/[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.63 - (show annotations) (download)
Sat Mar 3 20:37:35 2007 UTC (7 years, 9 months ago) by betelgeuse
Branch: MAIN
Changes since 1.62: +28 -1 lines
Add java-pkg_doexamples

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

  ViewVC Help
Powered by ViewVC 1.1.20