/[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.99 - (show annotations) (download)
Wed Nov 28 01:54:13 2007 UTC (6 years, 10 months ago) by betelgeuse
Branch: MAIN
Changes since 1.98: +27 -3 lines
Improvements to dojavadoc.

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

  ViewVC Help
Powered by ViewVC 1.1.20