/[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.89 - (hide annotations) (download)
Thu Jun 7 12:17:54 2007 UTC (7 years, 1 month ago) by caster
Branch: MAIN
Changes since 1.88: +2 -2 lines
Raise java-config dependency to 2.0.32.

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

  ViewVC Help
Powered by ViewVC 1.1.20