/[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.79 - (show annotations) (download)
Thu Apr 26 14:50:00 2007 UTC (7 years, 5 months ago) by caster
Branch: MAIN
Changes since 1.78: +15 -10 lines
Fix java-pkg_jar-from() when called with multiple comma-separated packages wrt ensure-dep and build-only.

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

  ViewVC Help
Powered by ViewVC 1.1.20