/[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.18 - (hide annotations) (download)
Sun Aug 27 16:53:51 2006 UTC (8 years, 3 months ago) by betelgeuse
Branch: MAIN
Changes since 1.17: +14 -9 lines
Fixed a bug where jar-from getjar and getjars did not die when the package requested is not installed.

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    
10    
11     # -----------------------------------------------------------------------------
12     # @eclass-begin
13     # @eclass-shortdesc Java Utility eclass
14     # @eclass-maintainer java@gentoo.org
15     #
16     # This eclass provides functionality which is used by
17     # java-pkg.eclass and java-pkg-opt.eclass as well as from ebuilds.
18     #
19     # @warning
20     # You probably don't want to inherit this directly from an ebuild. Instead,
21     # you should inherit java-ant for Ant-based Java packages, java-pkg for other
22     # Java packages, or java-pkg-opt for packages that have optional Java support.
23     #
24     # -----------------------------------------------------------------------------
25    
26     inherit eutils versionator multilib
27    
28     # -----------------------------------------------------------------------------
29     # @section-begin variables
30     # @section-title Variables
31     #
32     # Summary of variables which control the behavior of building Java packges.
33     # -----------------------------------------------------------------------------
34    
35     # Make sure we use java-config-2
36     export WANT_JAVA_CONFIG="2"
37    
38 nichoj 1.7 # TODO document
39     JAVA_PKG_PORTAGE_DEP=">=sys-apps/portage-2.1_pre1"
40    
41 nichoj 1.1 # -----------------------------------------------------------------------------
42     # @variable-internal JAVA_PKG_E_DEPEND
43     #
44     # This is a convience variable to be used from the other java eclasses. This is
45     # the version of java-config we want to use. We also need a recent version
46     # portage, that includes phase hooks.
47     # -----------------------------------------------------------------------------
48 nichoj 1.7 JAVA_PKG_E_DEPEND=">=dev-java/java-config-2.0.19-r1 ${JAVA_PKG_PORTAGE_DEP}"
49 nichoj 1.1
50     # -----------------------------------------------------------------------------
51     # @variable-external JAVA_PKG_ALLOW_VM_CHANGE
52     # @variable-default yes
53     #
54     # Allow this eclass to change the active VM?
55     # If your system VM isn't sufficient for the package, the build will fail.
56     # @note This is useful for testing specific VMs.
57     # -----------------------------------------------------------------------------
58     JAVA_PKG_ALLOW_VM_CHANGE=${JAVA_PKG_ALLOW_VM_CHANGE:="yes"}
59    
60     # -----------------------------------------------------------------------------
61     # @variable-external JAVA_PKG_FORCE_VM
62     #
63     # Explicitly set a particular VM to use. If its not valid, it'll fall back to
64     # whatever /etc/java-config-2/build/jdk.conf would elect to use.
65     #
66     # Should only be used for testing and debugging.
67     #
68     # @example Use sun-jdk-1.5 to emerge foo
69     # JAVA_PKG_FORCE_VM=sun-jdk-1.5 emerge foo
70     #
71     # -----------------------------------------------------------------------------
72    
73     # -----------------------------------------------------------------------------
74     # @variable-external JAVA_PKG_WANT_SOURCE
75     #
76     # Specify a specific VM version to compile for to use for -source.
77     # Normally this is determined from DEPEND.
78     # See java-pkg_get-source function below.
79     #
80     # Should only be used for testing and debugging.
81     #
82     # @seealso java-pkg_get-source
83     #
84     # @example Use 1.4 source to emerge baz
85     # JAVA_PKG_WANT_SOURCE=1.4 emerge baz
86     # -----------------------------------------------------------------------------
87    
88     # -----------------------------------------------------------------------------
89     # @variable-external JAVA_PKG_WANT_TARGET
90     #
91     # Same as JAVA_PKG_WANT_SOURCE above but for -target.
92     # See java-pkg_get-target function below.
93     #
94     # Should only be used for testing and debugging.
95     #
96     # @seealso java-pkg_get-target
97     #
98     # @example emerge bar to be compatible with 1.3
99     # JAVA_PKG_WANT_TARGET=1.3 emerge bar
100     # -----------------------------------------------------------------------------
101    
102     # -----------------------------------------------------------------------------
103     # @variable-internal JAVA_PKG_COMPILER_DIR
104     # @default /usr/share/java-config-2/compiler
105     #
106     # Directory where compiler settings are saved, without trailing slash.
107     # Probably shouldn't touch this variable.
108     # -----------------------------------------------------------------------------
109     JAVA_PKG_COMPILER_DIR=${JAVA_PKG_COMPILER_DIR:="/usr/share/java-config-2/compiler"}
110    
111    
112     # -----------------------------------------------------------------------------
113     # @variable-internal JAVA_PKG_COMPILERS_CONF
114     # @variable-default /etc/java-config-2/build/compilers.conf
115     #
116     # Path to file containing information about which compiler to use.
117     # Can be overloaded, but it should be overloaded for testing.
118     # -----------------------------------------------------------------------------
119     JAVA_PKG_COMPILERS_CONF=${JAVA_PKG_COMPILERS_CONF:="/etc/java-config-2/build/compilers.conf"}
120    
121     # -----------------------------------------------------------------------------
122     # @variable-external JAVA_PKG_FORCE_COMPILER
123     #
124     # Explicitly set a list of compilers to use. This is normally read from
125     # JAVA_PKG_COMPILERS_CONF.
126     #
127     # @note This should only be used internally or for testing.
128     # @example Use jikes and javac, in that order
129     # JAVA_PKG_FORCE_COMPILER="jikes javac"
130     # -----------------------------------------------------------------------------
131    
132     # TODO document me
133     JAVA_PKG_QA_VIOLATIONS=0
134    
135     # -----------------------------------------------------------------------------
136     # @section-end variables
137     # -----------------------------------------------------------------------------
138    
139    
140     # -----------------------------------------------------------------------------
141     # @section-begin install
142     # @section-summary Install functions
143     #
144     # These are used to install Java-related things, such as jars, Javadocs, JNI
145     # libraries, etc.
146     # -----------------------------------------------------------------------------
147    
148    
149     # -----------------------------------------------------------------------------
150     # @ebuild-function java-pkg_dojar
151     #
152     # Installs any number of jars.
153     # Jar's will be installed into /usr/share/${PN}(-${SLOT})/lib/ by default.
154     # You can use java-pkg_jarinto to change this path.
155     # You should never install a jar with a package version in the filename.
156     # Instead, use java-pkg_newjar defined below.
157     #
158     # @example
159     # java-pkg_dojar dist/${PN}.jar dist/${PN}-core.jar
160     #
161     # @param $* - list of jars to install
162     # ------------------------------------------------------------------------------
163     java-pkg_dojar() {
164     debug-print-function ${FUNCNAME} $*
165    
166     [[ ${#} -lt 1 ]] && die "At least one argument needed"
167    
168     java-pkg_check-phase install
169     java-pkg_init_paths_
170    
171     # Create JARDEST if it doesn't exist
172     dodir ${JAVA_PKG_JARDEST}
173    
174     local jar
175     # for each jar
176     for jar in "$@"; do
177     local jar_basename=$(basename "${jar}")
178    
179     java-pkg_check-versioned-jar ${jar_basename}
180    
181     # check if it exists
182     if [[ -e "${jar}" ]] ; then
183     # install it into JARDEST if it's a non-symlink
184     if [[ ! -L "${jar}" ]] ; then
185     INSDESTTREE="${JAVA_PKG_JARDEST}" \
186     doins "${jar}" || die "failed to install ${jar}"
187     java-pkg_append_ JAVA_PKG_CLASSPATH "${JAVA_PKG_JARDEST}/${jar_basename}"
188     debug-print "installed ${jar} to ${D}${JAVA_PKG_JARDEST}"
189     # make a symlink to the original jar if it's symlink
190     else
191     # TODO use dosym, once we find something that could use it
192     # -nichoj
193     ln -s "$(readlink "${jar}")" "${D}${JAVA_PKG_JARDEST}/${jar_basename}"
194     debug-print "${jar} is a symlink, linking accordingly"
195     fi
196     else
197     die "${jar} does not exist"
198     fi
199     done
200    
201     java-pkg_do_write_
202     }
203    
204    
205    
206     # ------------------------------------------------------------------------------
207     # @ebuild-function java-pkg_regjar
208     #
209     # Records an already installed jar in the package.env
210     # This would mostly be used if the package has make or a custom script to
211     # install things.
212     #
213     # Example:
214 nelchael 1.5 # java-pkg_regjar ${D}/opt/foo/lib/foo.jar
215     #
216     # WARNING:
217     # if you want to use shell expansion, you have to use ${D}/... as the for in
218     # this function will not be able to expand the path, here's an example:
219     #
220     # java-pkg_regjar /opt/my-java/lib/*.jar
221     #
222     # will not work, because:
223     # * the `for jar in "$@"` can't expand the path to jar file names, as they
224     # don't exist yet
225     # * all `if ...` inside for will fail - the file '/opt/my-java/lib/*.jar'
226     # doesn't exist
227     #
228     # you have to use it as:
229     #
230     # java-pkg_regjar ${D}/opt/my-java/lib/*.jar
231 nichoj 1.1 #
232     # @param $@ - jars to record
233     # ------------------------------------------------------------------------------
234 nichoj 1.10 # TODO should we be making sure the jar is present on ${D} or wherever?
235 nichoj 1.1 java-pkg_regjar() {
236     debug-print-function ${FUNCNAME} $*
237    
238     java-pkg_check-phase install
239    
240     [[ ${#} -lt 1 ]] && die "at least one argument needed"
241    
242     java-pkg_init_paths_
243    
244     local jar jar_dir jar_file
245     for jar in "$@"; do
246     # TODO use java-pkg_check-versioned-jar
247     if [[ -e "${jar}" ]]; then
248 nelchael 1.5 # nelchael: we should strip ${D} in this case too, here's why:
249     # imagine such call:
250     # java-pkg_regjar ${D}/opt/java/*.jar
251     # such call will fall into this case (-e ${jar}) and will
252     # record paths with ${D} in package.env
253     java-pkg_append_ JAVA_PKG_CLASSPATH "${jar#${D}}"
254 nichoj 1.1 elif [[ -e "${D}${jar}" ]]; then
255     java-pkg_append_ JAVA_PKG_CLASSPATH "${jar#${D}}"
256     else
257     die "${jar} does not exist"
258     fi
259     done
260    
261     java-pkg_do_write_
262     }
263    
264    
265     # ------------------------------------------------------------------------------
266     # @ebuild-function java-pkg_newjar
267     #
268     # Installs a jar with a new name
269     #
270     # @example: install a versioned jar without the version
271     # java-pkg_newjar dist/${P}.jar ${PN}.jar
272     #
273     # @param $1 - jar to install
274     # @param $2 - new name for jar - defaults to ${PN}.jar if not specified
275     # ------------------------------------------------------------------------------
276     java-pkg_newjar() {
277     debug-print-function ${FUNCNAME} $*
278    
279     local original_jar="${1}"
280     local new_jar="${2:-${PN}.jar}"
281     local new_jar_dest="${T}/${new_jar}"
282    
283     [[ -z ${original_jar} ]] && die "Must specify a jar to install"
284 nichoj 1.6 [[ ! -f ${original_jar} ]] && die "${original_jar} does not exist!"
285 nichoj 1.1
286     rm -f "${new_jar_dest}" || die "Failed to remove ${new_jar_dest}"
287     cp "${original_jar}" "${new_jar_dest}" \
288     || die "Failed to copy ${original_jar} to ${new_jar_dest}"
289     java-pkg_dojar "${new_jar_dest}"
290     }
291    
292    
293     # ------------------------------------------------------------------------------
294     # @ebuild-function java-pkg_addcp
295     #
296     # Add something to the package's classpath. For jars, you should use dojar,
297     # newjar, or regjar. This is typically used to add directories to the classpath.
298     #
299     # TODO add example
300     # @param $@ - value to append to JAVA_PKG_CLASSPATH
301     # ------------------------------------------------------------------------------
302     java-pkg_addcp() {
303     java-pkg_append_ JAVA_PKG_CLASSPATH "${@}"
304     java-pkg_do_write_
305     }
306    
307    
308     # ------------------------------------------------------------------------------
309     # @ebuild-function java-pkg_doso
310     #
311     # Installs any number of JNI libraries
312     # They will be installed into /usr/lib by default, but java-pkg_sointo
313     # can be used change this path
314     #
315     # Example:
316     # java-pkg_doso *.so
317     #
318     # @param $@ - JNI libraries to install
319     # ------------------------------------------------------------------------------
320     java-pkg_doso() {
321     debug-print-function ${FUNCNAME} $*
322    
323     [[ ${#} -lt 1 ]] && "At least one argument required for ${FUNCNAME}"
324     java-pkg_check-phase install
325    
326     [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}"
327    
328     java-pkg_init_paths_
329    
330     local lib
331     # for each lib
332     for lib in "$@" ; do
333     # if the lib exists...
334     if [[ -e "${lib}" ]] ; then
335     # install if it isn't a symlink
336     if [[ ! -L "${lib}" ]] ; then
337     INSDESTTREE="${JAVA_PKG_LIBDEST}" \
338     INSOPTIONS="${LIBOPTIONS}" \
339     doins "${lib}" || "failed to install ${lib}"
340     java-pkg_append_ JAVA_PKG_LIBRARY "${JAVA_PKG_LIBDEST}"
341     debug-print "Installing ${lib} to ${JAVA_PKG_LIBDEST}"
342     # otherwise make a symlink to the symlink's origin
343     else
344     # TODO use dosym
345     ln -s "$(readlink "${lib}")" "${D}${JAVA_PKG_LIBDEST}/$(basename "${lib}")"
346     debug-print "${lib} is a symlink, linking accordanly"
347     fi
348     # otherwise die
349     else
350     die "${lib} does not exist"
351     fi
352     done
353    
354     java-pkg_do_write_
355     }
356    
357     # ------------------------------------------------------------------------------
358     # @ebuild-function java-pkg_regso
359     #
360     # Registers an already JNI library in package.env.
361     #
362     # Example:
363     # java-pkg_regso *.so /path/*.so
364     #
365     # @param $@ - JNI libraries to register
366     # ------------------------------------------------------------------------------
367     java-pkg_regso() {
368     debug-print-function ${FUNCNAME} $*
369    
370     java-pkg_check-phase install
371    
372     [[ ${#} -lt 1 ]] && "at least one argument needed"
373    
374     java-pkg_init_paths_
375    
376     local lib target_dir
377     for lib in "$@" ; do
378     # Check the absolute path of the lib
379     if [[ -e "${lib}" ]] ; then
380     target_dir="$(java-pkg_expand_dir_ ${lib})"
381     java-pkg_append_ JAVA_PKG_LIBRARY "/${target_dir#${D}}"
382     # Check the path of the lib relative to ${D}
383     elif [[ -e "${D}${lib}" ]]; then
384     target_dir="$(java-pkg_expand_dir_ ${D}${lib})"
385     java-pkg_append_ JAVA_PKG_LIBRARY "${target_dir}"
386     else
387     die "${lib} does not exist"
388     fi
389     done
390    
391     java-pkg_do_write_
392     }
393    
394     # ------------------------------------------------------------------------------
395     # @ebuild-function java-pkg_jarinto
396     #
397     # Changes the path jars are installed into
398     #
399     # @param $1 - new location to install jars into.
400     # -----------------------------------------------------------------------------
401     java-pkg_jarinto() {
402     debug-print-function ${FUNCNAME} $*
403    
404     JAVA_PKG_JARDEST="${1}"
405     }
406    
407     # ------------------------------------------------------------------------------
408     # @ebuild-function java-pkg_sointo
409     #
410     # Changes the path that JNI libraries are installed into.
411     #
412     # @param $1 - new location to install JNI libraries into.
413     # ------------------------------------------------------------------------------
414     java-pkg_sointo() {
415     debug-print-function ${FUNCNAME} $*
416    
417     JAVA_PKG_LIBDEST="${1}"
418     }
419    
420     # ------------------------------------------------------------------------------
421     # @ebuild-function java-pkg_dohtml
422     #
423     # Install Javadoc HTML documentation
424     #
425     # @example
426     # java-pkg_dohtml dist/docs/
427     #
428     # ------------------------------------------------------------------------------
429     java-pkg_dohtml() {
430     debug-print-function ${FUNCNAME} $*
431    
432     [[ ${#} -lt 1 ]] && die "At least one argument required for ${FUNCNAME}"
433     # TODO-nichoj find out what exactly -f package-list does
434     dohtml -f package-list "$@"
435     # this probably shouldn't be here but it provides
436     # a reasonable way to catch # docs for all of the
437     # old ebuilds.
438     java-pkg_recordjavadoc
439     }
440    
441     # TODO document
442     java-pkg_dojavadoc() {
443     local dir="$1"
444    
445     java-pkg_check-phase install
446    
447     [[ -z "${dir}" ]] && die "Must specify a directory!"
448     [[ ! -d "${dir}" ]] && die "${dir} does not exist, or isn't a directory!"
449    
450     local dir_to_install="${dir}"
451     if [[ "$(basename "${dir}")" != "api" ]]; then
452     dir_to_install="${T}/api"
453     # TODO use doins
454     cp -r "${dir}" "${dir_to_install}" || die "cp failed"
455     fi
456    
457     java-pkg_dohtml -r ${dir_to_install}
458     }
459    
460     # ------------------------------------------------------------------------------
461     # @ebuild-function java-pkg_dosrc
462     #
463     # Installs a zip containing the source for a package, so it can used in
464     # from IDEs like eclipse and netbeans.
465     #
466     # Ebuild needs to DEPEND on app-arch/zip to use this.
467     #
468     # It also should be controlled by USE=source.
469     #
470     # @example:
471     # java-pkg_dosrc src/*
472     #
473     # ------------------------------------------------------------------------------
474     # TODO change so it the arguments it takes are the base directories containing
475     # source -nichoj
476     # TODO should we be able to handle multiple calls to dosrc? -nichoj
477     # TODO maybe we can take an existing zip/jar? -nichoj
478     # FIXME apparently this fails if you give it an empty directories
479     java-pkg_dosrc() {
480     debug-print-function ${FUNCNAME} $*
481    
482     [ ${#} -lt 1 ] && die "At least one argument needed"
483     if ! hasq source ${IUSE}; then
484     echo "Java QA Notice: ${FUNCNAME} called without source in IUSE"
485     fi
486    
487     java-pkg_check-phase install
488    
489     [[ ${#} -lt 1 ]] && die "At least one argument needed"
490    
491     java-pkg_init_paths_
492    
493     local zip_name="${PN}-src.zip"
494     local zip_path="${T}/${zip_name}"
495     local dir
496     for dir in ${@}; do
497     local dir_parent=$(dirname "${dir}")
498     local dir_name=$(basename "${dir}")
499     pushd ${dir_parent} > /dev/null || die "problem entering ${dir_parent}"
500     zip -q -r ${zip_path} ${dir_name} -i '*.java'
501     local result=$?
502     # 12 means zip has nothing to do
503     if [[ ${result} != 12 && ${result} != 0 ]]; then
504     die "failed to zip ${dir_name}"
505     fi
506     popd >/dev/null
507     done
508    
509     # Install the zip
510     INSDESTTREE=${JAVA_PKG_SOURCESPATH} \
511     doins ${zip_path} || die "Failed to install source"
512    
513     JAVA_SOURCES="${JAVA_PKG_SOURCESPATH}/${zip_name}"
514     java-pkg_do_write_
515     }
516    
517     # ------------------------------------------------------------------------------
518     # @ebuild-function java-pkg_dolauncher
519     #
520     # Make a wrapper script to lauch/start this package
521     # If necessary, the wrapper will switch to the appropriate VM.
522     #
523     # @param $1 - filename of launcher to create
524     # @param $2 - options, as follows:
525     # --main the.main.class.too.start
526     # --jar /the/jar/too/launch.jar
527     # --java_args 'Extra arguments to pass too jave'
528     # --pkg_args 'extra arguments too pass too the package'
529     # --pwd
530     # -into
531     # -pre
532     # ------------------------------------------------------------------------------
533     java-pkg_dolauncher() {
534     debug-print-function ${FUNCNAME} $*
535    
536     java-pkg_check-phase install
537    
538     [[ ${#} -lt 1 ]] && die "Need at least one argument"
539    
540     java-pkg_init_paths_
541    
542     local name="${1}"
543     # TODO rename to launcher
544     local target="${T}/${name}"
545     local target_dir pre
546     shift
547    
548     echo "#!/bin/bash" > "${target}"
549     while [[ -n "${1}" && -n "${2}" ]]; do
550     local var=${1} value=${2}
551     if [[ "${var:0:2}" == "--" ]]; then
552     echo "gjl_${var:2}=\"${value}\"" >> "${target}"
553     elif [[ "${var}" == "-into" ]]; then
554     target_dir="${value}"
555     elif [[ "${var}" == "-pre" ]]; then
556     pre="${value}"
557     fi
558     shift 2
559     done
560     echo "gjl_package=${JAVA_PKG_NAME}" >> "${target}"
561     [[ -n "${pre}" ]] && [[ -f "${pre}" ]] && cat "${pre}" >> "${target}"
562     echo "source /usr/share/java-config-2/launcher/launcher.bash" >> "${target}"
563    
564 nichoj 1.17 if [[ -n "${target_dir}" ]]; then
565 nichoj 1.1 DESTTREE="${target_dir}" dobin "${target}"
566     local ret=$?
567     return ${ret}
568     else
569     dobin "${target}"
570     fi
571     }
572    
573     # ------------------------------------------------------------------------------
574     # Install war files.
575     # TODO document
576     # ------------------------------------------------------------------------------
577     java-pkg_dowar() {
578     debug-print-function ${FUNCNAME} $*
579    
580     # Check for arguments
581     [[ ${#} -lt 1 ]] && die "At least one argument needed"
582     java-pkg_check-phase install
583    
584     java-pkg_init_paths_
585    
586     local war
587     for war in $* ; do
588     local warpath
589     # TODO evaluate if we want to handle symlinks differently -nichoj
590     # Check for symlink
591     if [[ -L "${war}" ]] ; then
592     cp "${war}" "${T}"
593     warpath="${T}$(basename "${war}")"
594     # Check for directory
595     # TODO evaluate if we want to handle directories differently -nichoj
596     elif [[ -d "${war}" ]] ; then
597     echo "dowar: warning, skipping directory ${war}"
598     continue
599     else
600     warpath="${war}"
601     fi
602 betelgeuse 1.18
603 nichoj 1.1 # Install those files like you mean it
604     INSOPTIONS="-m 0644" \
605     INSDESTTREE=${JAVA_PKG_WARDEST} \
606     doins ${warpath}
607     done
608     }
609    
610     # ------------------------------------------------------------------------------
611     # @internal-function java-pkg_recordjavadoc
612     # Scan for JavaDocs, and record their existence in the package.env file
613     #
614     # TODO make sure this in the proper section
615     # ------------------------------------------------------------------------------
616     java-pkg_recordjavadoc()
617     {
618     debug-print-function ${FUNCNAME} $*
619     # the find statement is important
620     # as some packages include multiple trees of javadoc
621     JAVADOC_PATH="$(find ${D}/usr/share/doc/ -name allclasses-frame.html -printf '%h:')"
622     # remove $D - TODO: check this is ok with all cases of the above
623     JAVADOC_PATH="${JAVADOC_PATH//${D}}"
624     if [[ -n "${JAVADOC_PATH}" ]] ; then
625     debug-print "javadocs found in ${JAVADOC_PATH%:}"
626     java-pkg_do_write_
627     else
628     debug-print "No javadocs found"
629     fi
630     }
631    
632     # ------------------------------------------------------------------------------
633     # @section-end install
634     # ------------------------------------------------------------------------------
635    
636     # ------------------------------------------------------------------------------
637     # @begin-section query
638     # Use these to build the classpath for building a package.
639     # ------------------------------------------------------------------------------
640    
641     # ------------------------------------------------------------------------------
642     # @ebuild-function java-pkg_jar-from
643     #
644     # Makes a symlink to a jar from a certain package
645     # A lot of java packages include dependencies in a lib/ directory
646     # You can use this function to replace these bundled dependencies.
647 nichoj 1.16 # The dependency is recorded into package.env DEPEND line, unless "--build-only"
648     # is passed as the very first argument, for jars that have to be present only
649     # at build time and are not needed on runtime (junit testing etc).
650 nichoj 1.1 #
651     # Example: get all jars from xerces slot 2
652     # java-pkg_jar-from xerces-2
653     # Example: get a specific jar from xerces slot 2
654     # java-pkg_jar-from xerces-2 xml-apis.jar
655 nichoj 1.16 # Example: get a specific jar from xerces slot 2, and name it diffrently
656 nichoj 1.1 # java-pkg_jar-from xerces-2 xml-apis.jar xml.jar
657 nichoj 1.16 # Example: get junit.jar which is needed only for building
658     # java-pkg_jar-from --build-only junit junit.jar
659 nichoj 1.1 #
660 nichoj 1.16 # @param $1 - (optional) "--build-only" makes the jar(s) not added into
661     # package.env DEPEND line.
662 nichoj 1.1 # @param $1 - Package to get jars from.
663     # @param $2 - jar from package. If not specified, all jars will be used.
664     # @param $3 - When a single jar is specified, destination filename of the
665     # symlink. Defaults to the name of the jar.
666     # ------------------------------------------------------------------------------
667     # TODO could probably be cleaned up a little
668     java-pkg_jar-from() {
669     debug-print-function ${FUNCNAME} $*
670    
671 nichoj 1.16 local build_only=""
672    
673     if [[ "${1}" = "--build-only" ]]; then
674     build_only="true"
675     shift
676     fi
677    
678 betelgeuse 1.18 local target_pkg="${1}" target_jar="${2}" destjar="${3}"
679    
680 nichoj 1.1 [[ -z ${target_pkg} ]] && die "Must specify a package"
681    
682     # default destjar to the target jar
683     [[ -z "${destjar}" ]] && destjar="${target_jar}"
684    
685 betelgeuse 1.18 local error_msg="There was a problem getting the classpath for ${target_pkg}."
686     local classpath
687     classpath="$(java-config --classpath=${target_pkg})"
688     [[ $? != 0 ]] && die ${error_msg}
689 nichoj 1.1
690     local jar
691     for jar in ${classpath//:/ }; do
692     local jar_name=$(basename "${jar}")
693     if [[ ! -f "${jar}" ]] ; then
694     debug-print "${jar} from ${target_pkg} does not exist"
695     die "Installation problems with jars in ${target_pkg} - is it installed?"
696     fi
697     # If no specific target jar was indicated, link it
698     if [[ -z "${target_jar}" ]] ; then
699     [[ -f "${target_jar}" ]] && rm "${target_jar}"
700     ln -snf "${jar}" \
701     || die "Failed to make symlink from ${jar} to ${jar_name}"
702 nichoj 1.16 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${target_pkg}" "${jar}"
703 nichoj 1.1 # otherwise, if the current jar is the target jar, link it
704     elif [[ "${jar_name}" == "${target_jar}" ]] ; then
705     [[ -f "${destjar}" ]] && rm "${destjar}"
706     ln -snf "${jar}" "${destjar}" \
707     || die "Failed to make symlink from ${jar} to ${destjar}"
708 nichoj 1.16 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${target_pkg}" "${jar}"
709 nichoj 1.1 return 0
710     fi
711     done
712     # if no target was specified, we're ok
713     if [[ -z "${target_jar}" ]] ; then
714     return 0
715     # otherwise, die bitterly
716     else
717     die "Failed to find ${target_jar:-jar} in ${target_pkg}"
718     fi
719     }
720    
721     # ------------------------------------------------------------------------------
722     # @ebuild-function java-pkg_jarfrom
723     #
724     # See java-pkg_jar-from
725     # ------------------------------------------------------------------------------
726     java-pkg_jarfrom() {
727     java-pkg_jar-from "$@"
728     }
729    
730     # ------------------------------------------------------------------------------
731     # @ebuild-function java-pkg_getjars
732     #
733     # Get the classpath provided by any number of packages
734     # Among other things, this can be passed to 'javac -classpath' or 'ant -lib'.
735 nichoj 1.16 # The providing packages are recorded as dependencies into package.env DEPEND
736     # line, unless "--build-only" is passed as the very first argument, for jars
737     # that have to be present only at build time and are not needed on runtime
738     # (junit testing etc).
739     #
740 nichoj 1.1 # Example: Get the classpath for xerces-2,
741     # java-pkg_getjars xerces-2 xalan
742     # Example Return:
743     # /usr/share/xerces-2/lib/xml-apis.jar:/usr/share/xerces-2/lib/xmlParserAPIs.jar:/usr/share/xalan/lib/xalan.jar
744 nichoj 1.16 #
745     # @param $1 - (optional) "--build-only" makes the jar(s) not added into
746     # package.env DEPEND line.
747 nichoj 1.1 # @param $@ - list of packages to get jars from
748     # ------------------------------------------------------------------------------
749     java-pkg_getjars() {
750     debug-print-function ${FUNCNAME} $*
751    
752 nichoj 1.16 local build_only=""
753    
754     if [[ "${1}" = "--build-only" ]]; then
755     build_only="true"
756     shift
757     fi
758    
759 nichoj 1.1 [[ ${#} -lt 1 ]] && die "At least one argument needed"
760    
761     # NOTE could probably just pass $@ to java-config --classpath. and return it
762     local classpath pkg
763     for pkg in ${@//,/ }; do
764     #for pkg in $(echo "$@" | tr ',' ' '); do
765     jars="$(java-config --classpath=${pkg})"
766 betelgeuse 1.18 [[ -z "${jars}" ]] && die "java-config --classpath=${pkg} failed"
767 nichoj 1.1 debug-print "${pkg}:${jars}"
768 betelgeuse 1.18
769 nichoj 1.1 if [[ -z "${classpath}" ]]; then
770     classpath="${jars}"
771     else
772     classpath="${classpath}:${jars}"
773     fi
774 nichoj 1.16 # Only record jars that aren't build-only
775     [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${pkg}"
776 nichoj 1.1 done
777     echo "${classpath}"
778     }
779    
780     # ------------------------------------------------------------------------------
781     # @ebuild-function java-pkg_getjar
782     #
783     # Get the filename of a single jar from a package
784 nichoj 1.16 # The providing package is recorded as runtime dependency into package.env
785     # DEPEND line, unless "--build-only" is passed as the very first argument, for
786     # jars that have to be present only at build time and are not needed on runtime
787     # (junit testing etc).
788 nichoj 1.1 #
789     # @example
790     # java-pkg_getjar xerces-2 xml-apis.jar
791     # @example-return
792     # /usr/share/xerces-2/lib/xml-apis.jar
793 nichoj 1.16 #
794     # @param $1 - (optional) "--build-only" makes the jar not added into
795     # package.env DEPEND line.
796 nichoj 1.1 # @param $1 - package to use
797     # @param $2 - jar to get
798     # ------------------------------------------------------------------------------
799     java-pkg_getjar() {
800     debug-print-function ${FUNCNAME} $*
801    
802 nichoj 1.16 local build_only=""
803    
804     if [[ "${1}" = "--build-only" ]]; then
805     build_only="true"
806     shift
807     fi
808    
809 nichoj 1.1 local pkg="${1}" target_jar="${2}" jar
810     [[ -z ${pkg} ]] && die "Must specify package to get a jar from"
811     [[ -z ${target_jar} ]] && die "Must specify jar to get"
812    
813 betelgeuse 1.18 local error_msg="Could not find classpath for ${pkg}. Are you sure its installed?"
814     local classpath
815     classpath=$(java-config --classpath=${pkg})
816     [[ $? != 0 ]] && die ${error_msg}
817    
818 nichoj 1.1 for jar in ${classpath//:/ }; do
819     if [[ ! -f "${jar}" ]] ; then
820 nichoj 1.16 die "Installation problem with jar ${jar} in ${pkg} - is it installed?"
821 nichoj 1.1 fi
822    
823     if [[ "$(basename ${jar})" == "${target_jar}" ]] ; then
824 nichoj 1.16 # Only record jars that aren't build-only
825     [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${pkg}" "${jar}"
826 nichoj 1.1 echo "${jar}"
827     return 0
828     fi
829     done
830    
831     die "Could not find ${target_jar} in ${pkg}"
832     return 1
833     }
834    
835     # This function reads stdin, and based on that input, figures out how to
836     # populate jars from the filesystem.
837     # Need to figure out a good way of making use of this, ie be able to use a
838     # string that was built instead of stdin
839     # NOTE: this isn't quite ready for primetime.
840     #java-pkg_populate-jars() {
841     # local line
842     #
843     # read line
844     # while [[ -n "${line}" ]]; do
845     # # Ignore comments
846     # [[ ${line%%#*} == "" ]] && continue
847     #
848     # # get rid of any spaces
849     # line="${line// /}"
850     #
851     # # format: path=jarinfo
852     # local path=${line%%=*}
853     # local jarinfo=${line##*=}
854     #
855     # # format: jar@package
856     # local jar=${jarinfo%%@*}.jar
857     # local package=${jarinfo##*@}
858     # if [[ -n ${replace_only} ]]; then
859     # [[ ! -f $path ]] && die "No jar exists at ${path}"
860     # fi
861     # if [[ -n ${create_parent} ]]; then
862     # local parent=$(dirname ${path})
863     # mkdir -p "${parent}"
864     # fi
865     # java-pkg_jar-from "${package}" "${jar}" "${path}"
866     #
867     # read line
868     # done
869     #}
870    
871     # ------------------------------------------------------------------------------
872     # @section-end query
873     # ------------------------------------------------------------------------------
874    
875     # ------------------------------------------------------------------------------
876     # @section-begin helper
877     # @section-summary Helper functions
878     #
879     # Various other functions to use from an ebuild
880     # ------------------------------------------------------------------------------
881    
882     # ------------------------------------------------------------------------------
883     # @ebuild-function java-pkg_need
884     #
885     # Adds virtual dependencies, which can optionally be controlled by a USE flag.
886     # Currently supported virtuals are:
887     # javamail
888     # jdbc-stdext
889     # jaf
890     # jdbc-rowset
891     # jms
892     #
893     # @param $1 - Optionally indicate that the dependencies are controlled by
894     # a use flag by specifying '--use' Requires $2.
895     # @param $2 - USE flag which will enable the dependencies.
896     # @param $@ - virtual packages to add depenedencies for
897     # ------------------------------------------------------------------------------
898     # TODO rewrite to parse a line based declaration file instead -- karltk
899     #java-pkg_need() {
900     # debug-print-function ${FUNCNAME} $*
901     # local useflag
902     # if [[ ${1} == "--use" ]]; then
903     # useflag="${2}"
904     # shift 2
905     # fi
906     #
907     # if [[ -z ${1} ]]; then
908     # die "Must specify at least one virtual package."
909     # fi
910     #
911     # local depstr newdepstr
912     #
913     # for virtual in ${@}; do
914     # if has ${virtual} ${JAVA_PKG_VNEED}; then
915     # debug-print "Already registered virtual ${virtual}"
916     # continue
917     # fi
918     # case ${virtual} in
919     # javamail)
920     # debug-print "java-pkg_need: adding javamail dependencies"
921     # newdepstr="|| ( dev-java/gnu-javamail dev-java/sun-javamail-bin )"
922     # ;;
923     # jdbc-stdext)
924     # debug-print "java-pkg_need: adding jdbc-stdext dependencies"
925     # newdepstr="|| ( >=virtual/jdk-1.4 dev-java/jdbc2-stdext )"
926     # ;;
927     # jaf)
928     # debug-print "java-pkg_need: adding jaf dependencies"
929     # newdepstr="|| ( dev-java/gnu-jaf dev-java/sun-jaf-bin )"
930     # ;;
931     # jdbc-rowset)
932     # debug-print "java-pkg_need: adding jdbc-rowset dependencies"
933     # newdepstr="|| ( >=virtual/jdk-1.5 dev-java/sun-jdbc-rowset )"
934     # ;;
935     # jms)
936     # debug-print "java-pkg_need: adding jms dependencies"
937     # newdepstr="|| ( dev-java/sun-jms dev-java/openjms )"
938     # ;;
939     # *)
940     # die "Invalid virtual: ${virtual}"
941     # esac
942     #
943     # export JAVA_PKG_VNEED="${JAVA_PKG_VNEED} ${virtual}"
944     #
945     # if [[ -n ${useflag} ]]; then
946     # depstr="${depstr} ${useflag}? ( ${newdepstr} )"
947     # else
948     # depstr="${depstr} ${newdepstr}"
949     # fi
950     # done
951     #
952     # [[ -z ${JAVA_PKG_NV_DEPEND} ]] && export JAVA_PKG_NV_DEPEND="${DEPEND}"
953     # [[ -z ${JAVA_PKG_NV_RDEPEND} ]] && export JAVA_PKG_NV_RDEPEND="${RDEPEND}"
954     #
955     # export DEPEND="${DEPEND} ${depstr}"
956     # export RDEPEND="${RDEPEND} ${depstr}"
957     #}
958    
959     # This should be used after S has been populated with symlinks to jars
960     # TODO document
961     java-pkg_ensure-no-bundled-jars() {
962     debug-print-function ${FUNCNAME} $*
963     pushd ${WORKDIR} >/dev/null 2>/dev/null
964    
965     local bundled_jars=$(find . -name "*.jar" -type f)
966     if [[ -n ${bundled_jars} ]]; then
967     echo "Bundled jars found:"
968     local jar
969     for jar in ${bundled_jars}; do
970     echo $(pwd)${jar/./}
971     done
972     die "Bundled jars found!"
973    
974     fi
975     popd >/dev/null 2>/dev/null
976     }
977    
978     # ------------------------------------------------------------------------------
979     # @internal-function java-pkg_ensure-vm-version-sufficient
980     #
981     # Checks if we have a sufficient VM and dies if we don't.
982     #
983     # ------------------------------------------------------------------------------
984     java-pkg_ensure-vm-version-sufficient() {
985     debug-print-function ${FUNCNAME} $*
986    
987     if ! java-pkg_is-vm-version-sufficient; then
988     debug-print "VM is not suffient"
989     eerror "Current Java VM cannot build this package"
990     einfo "Please use java-config -S to set the correct one"
991     die "Active Java VM cannot build this package"
992     fi
993     }
994    
995     # ------------------------------------------------------------------------------
996     # @internal-function java-pkg_is-vm-version-sufficient
997     #
998     # @return zero - VM is sufficient
999     # @return non-zero - VM is not sufficient
1000     # ------------------------------------------------------------------------------
1001     java-pkg_is-vm-version-sufficient() {
1002     debug-print-function ${FUNCNAME} $*
1003    
1004     depend-java-query --is-sufficient "${DEPEND}" > /dev/null
1005     return $?
1006     }
1007    
1008     # ------------------------------------------------------------------------------
1009     # @internal-function java-pkg_ensure-vm-version-eq
1010     #
1011     # Die if the current VM is not equal to the argument passed.
1012     #
1013     # @param $@ - Desired VM version to ensure
1014     # ------------------------------------------------------------------------------
1015     java-pkg_ensure-vm-version-eq() {
1016     debug-print-function ${FUNCNAME} $*
1017    
1018     if ! java-pkg_is-vm-version-eq $@ ; then
1019     debug-print "VM is not suffient"
1020     eerror "This package requires a Java VM version = $@"
1021     einfo "Please use java-config -S to set the correct one"
1022     die "Active Java VM too old"
1023     fi
1024     }
1025    
1026     # ------------------------------------------------------------------------------
1027     # @internal-function java-pkg_is-vm-version-eq
1028     #
1029     # @param $@ - VM version to compare current VM to
1030     # @return zero - VM versions are equal
1031     # @return non-zero - VM version are not equal
1032     # ------------------------------------------------------------------------------
1033     java-pkg_is-vm-version-eq() {
1034     debug-print-function ${FUNCNAME} $*
1035    
1036     local needed_version="$@"
1037    
1038     [[ -z "${needed_version}" ]] && die "need an argument"
1039    
1040     local vm_version="$(java-pkg_get-vm-version)"
1041    
1042     vm_version="$(get_version_component_range 1-2 "${vm_version}")"
1043     needed_version="$(get_version_component_range 1-2 "${needed_version}")"
1044    
1045     if [[ -z "${vm_version}" ]]; then
1046     debug-print "Could not get JDK version from DEPEND"
1047     return 1
1048     else
1049     if [[ "${vm_version}" == "${needed_version}" ]]; then
1050     debug-print "Detected a JDK(${vm_version}) = ${needed_version}"
1051     return 0
1052     else
1053     debug-print "Detected a JDK(${vm_version}) != ${needed_version}"
1054     return 1
1055     fi
1056     fi
1057     }
1058    
1059     # ------------------------------------------------------------------------------
1060     # @internal-function java-pkg_ensure-vm-version-ge
1061     #
1062     # Die if the current VM is not greater than the desired version
1063     #
1064     # @param $@ - VM version to compare current to
1065     # ------------------------------------------------------------------------------
1066     java-pkg_ensure-vm-version-ge() {
1067     debug-print-function ${FUNCNAME} $*
1068    
1069     if ! java-pkg_is-vm-version-ge "$@" ; then
1070     debug-print "vm is not suffient"
1071     eerror "This package requires a Java VM version >= $@"
1072     einfo "Please use java-config -S to set the correct one"
1073     die "Active Java VM too old"
1074     fi
1075     }
1076    
1077     # ------------------------------------------------------------------------------
1078     # @internal-function java-pkg_is-vm-version-ge
1079     #
1080     # @param $@ - VM version to compare current VM to
1081     # @return zero - current VM version is greater than checked version
1082     # @return non-zero - current VM version is not greater than checked version
1083     # ------------------------------------------------------------------------------
1084     java-pkg_is-vm-version-ge() {
1085     debug-print-function ${FUNCNAME} $*
1086    
1087     local needed_version=$@
1088     local vm_version=$(java-pkg_get-vm-version)
1089     if [[ -z "${vm_version}" ]]; then
1090     debug-print "Could not get JDK version from DEPEND"
1091     return 1
1092     else
1093     if version_is_at_least "${needed_version}" "${vm_version}"; then
1094     debug-print "Detected a JDK(${vm_version}) >= ${needed_version}"
1095     return 0
1096     else
1097     debug-print "Detected a JDK(${vm_version}) < ${needed_version}"
1098     return 1
1099     fi
1100     fi
1101     }
1102    
1103 nichoj 1.12 java-pkg_set-current-vm() {
1104     export GENTOO_VM=${1}
1105     }
1106    
1107     java-pkg_get-current-vm() {
1108     echo ${GENTOO_VM}
1109     }
1110    
1111     java-pkg_current-vm-matches() {
1112 nichoj 1.15 hasq $(java-pkg_get-current-vm) ${@}
1113 nichoj 1.12 return $?
1114     }
1115    
1116 nichoj 1.1 # ------------------------------------------------------------------------------
1117     # @ebuild-function java-pkg_get-source
1118     #
1119     # Determines what source version should be used, for passing to -source.
1120     # Unless you want to break things you probably shouldn't set _WANT_SOURCE
1121     #
1122     # @return string - Either the lowest possible source, or JAVA_PKG_WANT_SOURCE
1123     # ------------------------------------------------------------------------------
1124     java-pkg_get-source() {
1125     echo ${JAVA_PKG_WANT_SOURCE:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1126     }
1127    
1128     # ------------------------------------------------------------------------------
1129     # @ebuild-function java-pkg_get-target
1130     #
1131     # Determines what target version should be used, for passing to -target.
1132     # If you don't care about lower versions, you can set _WANT_TARGET to the
1133     # version of your JDK.
1134     # Remember doing this will mostly like cause things to break.
1135     # Doesn't allow it to be lower then the one in depend.
1136     # Doesn't allow it to be higher then the active vm.
1137     #
1138     # @return string - Either the lowest possible target, or JAVA_PKG_WANT_TARGET
1139     # ------------------------------------------------------------------------------
1140     java-pkg_get-target() {
1141     local min=$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")
1142     if [[ -n "${JAVA_PKG_WANT_TARGET}" ]]; then
1143     local max="$(java-config --select-vm "${GENTOO_VM}" -g PROVIDES_VERSION)"
1144     if version_is_at_least "${min}" "${JAVA_PKG_WANT_TARGET}" && version_is_at_least "${JAVA_PKG_WANT_TARGET}" "${max}"; then
1145     echo ${JAVA_PKG_WANT_TARGET}
1146     else
1147     echo ${min}
1148     fi
1149     else
1150     echo ${min}
1151     fi
1152    
1153     #echo ${JAVA_PKG_WANT_TARGET:-$(depend-java-query --get-lowest "${DEPEND}")}
1154     }
1155    
1156     java-pkg_get-javac() {
1157     debug-print-function ${FUNCNAME} $*
1158    
1159     java-pkg_init-compiler_
1160     local compiler="${GENTOO_COMPILER}"
1161    
1162     local compiler_executable
1163     if [[ "${compiler}" = "javac" ]]; then
1164     # nothing fancy needs to be done for javac
1165     compiler_executable="javac"
1166     else
1167     # for everything else, try to determine from an env file
1168    
1169     local compiler_env="/usr/share/java-config-2/compiler/${compiler}"
1170     if [[ -f ${compiler_env} ]]; then
1171     local old_javac=${JAVAC}
1172     unset JAVAC
1173     # try to get value of JAVAC
1174     compiler_executable="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${JAVAC})"
1175     export JAVAC=${old_javac}
1176    
1177     [[ -z ${compiler_executable} ]] && die "JAVAC is empty or undefined in ${compiler_env}"
1178    
1179     # check that it's executable
1180     if [[ ! -x ${compiler_executable} ]]; then
1181     eerror "Could not find ${compiler_executable}!"
1182     die "${compiler_executable} doesn't exist, or isn't executable"
1183     fi
1184     else
1185     eerror "Could not find environment file for ${compiler}"
1186     die "Could not find ${compiler_env}"
1187     fi
1188     fi
1189     echo ${compiler_executable}
1190     }
1191    
1192     # ------------------------------------------------------------------------------
1193     # @ebuild-function java-pkg_javac-args
1194     #
1195     # If an ebuild uses javac directly, instead of using ejavac, it should call this
1196     # to know what -source/-target to use.
1197     #
1198     # @return string - arguments to pass to javac, complete with -target and -source
1199     # ------------------------------------------------------------------------------
1200     java-pkg_javac-args() {
1201     debug-print-function ${FUNCNAME} $*
1202    
1203     local want_source="$(java-pkg_get-source)"
1204     local want_target="$(java-pkg_get-target)"
1205    
1206     local source_str="-source ${want_source}"
1207     local target_str="-target ${want_target}"
1208    
1209     debug-print "want source: ${want_source}"
1210     debug-print "want target: ${want_target}"
1211    
1212     if [[ -z "${want_source}" || -z "${want_target}" ]]; then
1213     debug-print "could not find valid -source/-target values"
1214     die "Could not find valid -source/-target values"
1215     else
1216     if java-pkg_is-vm-version-ge "1.4"; then
1217     echo "${source_str} ${target_str}"
1218     else
1219     echo "${target_str}"
1220     fi
1221     fi
1222     }
1223    
1224     # TODO document
1225     java-pkg_get-jni-cflags() {
1226     local flags="-I${JAVA_HOME}/include"
1227    
1228 nichoj 1.10 # TODO do a check that the directories are valid
1229 nichoj 1.1 # TODO figure out how to cope with other things than linux...
1230     flags="${flags} -I${JAVA_HOME}/include/linux"
1231    
1232     echo ${flags}
1233     }
1234    
1235 nichoj 1.10 java-pkg_ensure-gcj() {
1236     if ! built_with_use sys-devel/gcc gcj ; then
1237     ewarn
1238     ewarn "You must build gcc with the gcj support to build with gcj"
1239     ewarn
1240     ebeep 5
1241     die "No GCJ support found!"
1242     fi
1243     }
1244    
1245 nichoj 1.13 java-pkg_ensure-test() {
1246     if hasq test ${FEATURES} && ! hasq -test ${FEATURES} && ! use test; then
1247     eerror "You specified FEATURES=test, but USE=test is needed"
1248     eerror "to pull in the additional dependencies for testing"
1249     die "Need USE=test enabled"
1250     fi
1251     }
1252    
1253 nichoj 1.1 # ------------------------------------------------------------------------------
1254     # @section-end helper
1255     # ------------------------------------------------------------------------------
1256    
1257     # ------------------------------------------------------------------------------
1258     # @section-begin build
1259     # @section-summary Build functions
1260     #
1261     # These are some functions for building a package. In particular, it consists of
1262     # wrappers for javac and ant.
1263     # ------------------------------------------------------------------------------
1264    
1265     # ------------------------------------------------------------------------------
1266     # @ebuild-function eant
1267     #
1268     # Ant wrapper function. Will use the appropriate compiler, based on user-defined
1269     # compiler.
1270     #
1271     # ------------------------------------------------------------------------------
1272     eant() {
1273     debug-print-function ${FUNCNAME} $*
1274    
1275 nichoj 1.12 # FIXME get this working
1276     # if is-java-strict && [[ ! ${DEPEND} =~ "dev-java/ant" ]]; then
1277     # java-pkg_announce-qa-violation \
1278     # "Using eant, but not depending on dev-java/ant or dev-java/ant-core"
1279     # fi
1280    
1281 nichoj 1.1 local antflags
1282     java-pkg_init-compiler_
1283     local compiler="${GENTOO_COMPILER}"
1284    
1285     local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1286    
1287     local build_compiler="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER})"
1288     if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then
1289     die "ANT_BUILD_COMPILER undefined in ${compiler_env}"
1290     fi
1291    
1292     if [[ ${compiler} != "javac" ]]; then
1293     antflags="-Dbuild.compiler=${build_compiler}"
1294     # Figure out any extra stuff to put on the classpath for compilers aside
1295     # from javac
1296     # ANT_BUILD_COMPILER_DEPS should be something that could be passed to
1297     # java-config -p
1298     local build_compiler_deps="$(source ${JAVA_PKG_COMPILER_DIR}/${compiler} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER_DEPS})"
1299     if [[ -n ${build_compiler_deps} ]]; then
1300     antflags="${antflags} -lib $(java-config -p ${build_compiler_deps})"
1301     fi
1302     fi
1303 nichoj 1.9
1304     if is-java-strict; then
1305     einfo "Disabling system classpath for ant"
1306     antflags="${antflags} -Dbuild.sysclasspath=ignore"
1307     fi
1308 nichoj 1.1
1309     if [[ -n ${JAVA_PKG_DEBUG} ]]; then
1310     antflags="${antflags} -debug"
1311     fi
1312    
1313     [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}"
1314     ant ${antflags} "${@}" || die "eant failed"
1315    
1316     }
1317    
1318     # ------------------------------------------------------------------------------
1319     # @ebuild-function ejavac
1320     #
1321     # Javac wrapper function. Will use the appropriate compiler, based on
1322     # /etc/java-config/compilers.conf
1323     #
1324     # @param $@ - Arguments to be passed to the compiler
1325     # ------------------------------------------------------------------------------
1326     ejavac() {
1327     debug-print-function ${FUNCNAME} $*
1328    
1329 nichoj 1.6 # FIXME using get-javac ends up printing stuff with einfo
1330     # local compiler_executable=$(java-pkg_get-javac)
1331     local compiler_executable="javac"
1332 nichoj 1.1
1333     [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} $(java-pkg_javac-args) "${@}"
1334     ${compiler_executable} $(java-pkg_javac-args) "${@}" || die "ejavac failed"
1335     }
1336    
1337     # ------------------------------------------------------------------------------
1338     # @ebuild-function java-pkg_filter-compiler
1339     #
1340     # Used to prevent the use of some compilers. Should be used in src_compile.
1341     # Basically, it just appends onto JAVA_PKG_FILTER_COMPILER
1342     #
1343     # @param $@ - compilers to filter
1344     # ------------------------------------------------------------------------------
1345     java-pkg_filter-compiler() {
1346     JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@"
1347     }
1348    
1349     # ------------------------------------------------------------------------------
1350 nichoj 1.8 # @ebuild-function java-pkg_force-compiler
1351     #
1352     # Used to force the use of particular compilers. Should be used in src_compile.
1353     # A common use of this would be to force ecj-3.1 to be used on amd64, to avoid
1354     # OutOfMemoryErrors that may come up.
1355     #
1356     # @param $@ - compilers to force
1357     # ------------------------------------------------------------------------------
1358     java-pkg_force-compiler() {
1359     JAVA_PKG_FORCE_COMPILER="$@"
1360     }
1361    
1362     # ------------------------------------------------------------------------------
1363 nichoj 1.1 # @ebuild-function use_doc
1364     #
1365     # Helper function for getting ant to build javadocs. If the user has USE=doc,
1366     # then 'javadoc' or the argument are returned. Otherwise, there is no return.
1367     #
1368     # The output of this should be passed to ant.
1369     #
1370     # Example: build javadocs by calling 'javadoc' target
1371     # eant $(use_doc)
1372     # Example: build javadocs by calling 'apidoc' target
1373     # eant $(use_doc apidoc)
1374     #
1375     # @param $@ - Option value to return. Defaults to 'javadoc'
1376     # @return string - Name of the target to create javadocs
1377     # ------------------------------------------------------------------------------
1378     use_doc() {
1379     use doc && echo ${@:-javadoc}
1380     }
1381    
1382     # ------------------------------------------------------------------------------
1383     # @section-end build
1384     # ------------------------------------------------------------------------------
1385    
1386     # ------------------------------------------------------------------------------
1387     # @section-begin internal
1388     # @section-summary Internal functions
1389     #
1390     # Do __NOT__ use any of these from an ebuild! These are only to be used from
1391     # within the java eclasses.
1392     # ------------------------------------------------------------------------------
1393    
1394     # -----------------------------------------------------------------------------
1395     # @function-internal java-pkg_init
1396     #
1397     # The purpose of this function, as the name might imply, is to initialize the
1398     # Java environment. It ensures that that there aren't any environment variables
1399     # that'll muss things up. It initializes some variables, which are used
1400     # internally. And most importantly, it'll switch the VM if necessary.
1401     #
1402     # This shouldn't be used directly. Instead, java-pkg and java-pkg-opt will
1403     # call it during each of the phases of the merge process.
1404     #
1405     # -----------------------------------------------------------------------------
1406     java-pkg_init() {
1407     unset JAVAC
1408     unset JAVA_HOME
1409     java-pkg_init_paths_
1410     java-pkg_switch-vm
1411     PATH=${JAVA_HOME}/bin:${PATH}
1412    
1413     # TODO we will probably want to set JAVAC and JAVACFLAGS
1414    
1415     # Do some QA checks
1416     java-pkg_check-jikes
1417    
1418     # When users have crazy classpaths some packages can fail to compile.
1419     # and everything should work with empty CLASSPATH.
1420     # This also helps prevent unexpected dependencies on random things
1421     # from the CLASSPATH.
1422     unset CLASSPATH
1423     }
1424    
1425     # ------------------------------------------------------------------------------
1426     # @function-internal java-pkg-init-compiler_
1427     #
1428     # This function attempts to figure out what compiler should be used. It does
1429     # this by reading the file at JAVA_PKG_COMPILERS_CONF, and checking the
1430     # COMPILERS variable defined there.
1431     # This can be overridden by a list in JAVA_PKG_FORCE_COMPILER
1432     #
1433     # It will go through the list of compilers, and verify that it supports the
1434     # target and source that are needed. If it is not suitable, then the next
1435     # compiler is checked. When JAVA_PKG_FORCE_COMPILER is defined, this checking
1436     # isn't done.
1437     #
1438     # Once the which compiler to use has been figured out, it is set to
1439     # GENTOO_COMPILER.
1440     #
1441     # If you hadn't guessed, JAVA_PKG_FORCE_COMPILER is for testing only.
1442     #
1443     # If the user doesn't defined anything in JAVA_PKG_COMPILERS_CONF, or no
1444     # suitable compiler was found there, then the default is to use javac provided
1445     # by the current VM.
1446     #
1447     #
1448     # @return name of the compiler to use
1449     # ------------------------------------------------------------------------------
1450     java-pkg_init-compiler_() {
1451     debug-print-function ${FUNCNAME} $*
1452    
1453     if [[ -n ${GENTOO_COMPILER} ]]; then
1454     debug-print "GENTOO_COMPILER already set"
1455     return
1456     fi
1457    
1458 nichoj 1.3 local compilers;
1459     if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
1460     compilers="$(source ${JAVA_PKG_COMPILERS_CONF} 1>/dev/null 2>&1; echo ${COMPILERS})"
1461     else
1462     compilers=${JAVA_PKG_FORCE_COMPILER}
1463     fi
1464    
1465 nichoj 1.1 debug-print "Read \"${compilers}\" from ${JAVA_PKG_COMPILERS_CONF}"
1466    
1467     # Figure out if we should announce what compiler we're using
1468     local compiler
1469     for compiler in ${compilers}; do
1470     debug-print "Checking ${compiler}..."
1471     # javac should always be alright
1472     if [[ ${compiler} = "javac" ]]; then
1473     debug-print "Found javac... breaking"
1474     export GENTOO_COMPILER="javac"
1475     break
1476     fi
1477    
1478     if has ${compiler} ${JAVA_PKG_FILTER_COMPILER}; then
1479     if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
1480     einfo "Filtering ${compiler}"
1481     continue
1482     fi
1483     fi
1484    
1485     # for non-javac, we need to make sure it supports the right target and
1486     # source
1487     local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1488     if [[ -f ${compiler_env} ]]; then
1489     local desired_target="$(java-pkg_get-target)"
1490     local desired_source="$(java-pkg_get-source)"
1491    
1492    
1493     # Verify that the compiler supports target
1494     local supported_target=$(source ${compiler_env} 1>/dev/null 2>&1; echo ${SUPPORTED_TARGET})
1495     if ! has ${desired_target} ${supported_target}; then
1496     ewarn "${compiler} does not support -target ${desired_target}, skipping"
1497     continue
1498     fi
1499    
1500     # -source was introduced in 1.3, so only check 1.3 and on
1501     if version_is_at_least "${desired_soure}" "1.3"; then
1502     # Verify that the compiler supports source
1503     local supported_source=$(source ${compiler_env} 1>/dev/null 2>&1; echo ${SUPPORTED_SOURCE})
1504     if ! has ${desired_source} ${supported_source}; then
1505     ewarn "${compiler} does not support -source ${desired_source}, skipping"
1506     continue
1507     fi
1508     fi
1509    
1510     # if you get here, then the compiler should be good to go
1511     export GENTOO_COMPILER="${compiler}"
1512     break
1513     else
1514     ewarn "Could not find configuration for ${compiler}, skipping"
1515     ewarn "Perhaps it is not installed?"
1516     continue
1517     fi
1518     done
1519    
1520     # If it hasn't been defined already, default to javac
1521     if [[ -z ${GENTOO_COMPILER} ]]; then
1522     if [[ -n ${compilers} ]]; then
1523     einfo "No suitable compiler found: defaulting javac for compilation"
1524     else
1525     # probably don't need to notify users about the default.
1526     :;#einfo "Defaulting to javac for compilation"
1527     fi
1528     export GENTOO_COMPILER=javac
1529     else
1530     einfo "Using ${GENTOO_COMPILER} for compilation"
1531     fi
1532    
1533     }
1534    
1535     # ------------------------------------------------------------------------------
1536     # @internal-function init_paths_
1537     #
1538     # Initializes some variables that will be used. These variables are mostly used
1539     # to determine where things will eventually get installed.
1540     # ------------------------------------------------------------------------------
1541     java-pkg_init_paths_() {
1542     debug-print-function ${FUNCNAME} $*
1543    
1544     local pkg_name
1545     if [[ "$SLOT" == "0" ]] ; then
1546     JAVA_PKG_NAME="${PN}"
1547     else
1548     JAVA_PKG_NAME="${PN}-${SLOT}"
1549     fi
1550    
1551     JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}"
1552     JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/"
1553     JAVA_PKG_ENV="${D}${JAVA_PKG_SHAREPATH}/package.env"
1554    
1555     [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib"
1556     [[ -z "${JAVA_PKG_LIBDEST}" ]] && JAVA_PKG_LIBDEST="${DESTTREE}/$(get_libdir)/${JAVA_PKG_NAME}"
1557     [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps"
1558    
1559    
1560     # TODO maybe only print once?
1561     debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}"
1562     debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}"
1563     debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}"
1564     debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}"
1565     debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}"
1566     }
1567    
1568     # ------------------------------------------------------------------------------
1569     # @internal-function java-pkg_do_write_
1570     #
1571     # Writes the package.env out to disk.
1572     #
1573     # ------------------------------------------------------------------------------
1574     # TODO change to do-write, to match everything else
1575     java-pkg_do_write_() {
1576     # Create directory for package.env
1577     dodir "${JAVA_PKG_SHAREPATH}"
1578     if [[ -n "${JAVA_PKG_CLASSPATH}" || -n "${JAVA_PKG_LIBRARY}" || -f "${JAVA_PKG_DEPEND}" ]]; then
1579     # Create package.env
1580     (
1581     echo "DESCRIPTION=\"${DESCRIPTION}\""
1582     echo "GENERATION=\"2\""
1583    
1584     [[ -n "${JAVA_PKG_CLASSPATH}" ]] && echo "CLASSPATH=\"${JAVA_PKG_CLASSPATH}\""
1585     [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\""
1586     [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\""
1587     [[ -f "${JAVA_PKG_DEPEND}" ]] && echo "DEPEND=\"$(cat ${JAVA_PKG_DEPEND} | uniq | tr '\n' ':')\""
1588     echo "VM=\"$(echo ${RDEPEND} ${DEPEND} | sed -e 's/ /\n/g' | sed -n -e '/virtual\/\(jre\|jdk\)/ { p;q }')\"" # TODO cleanup !
1589     ) > "${JAVA_PKG_ENV}"
1590    
1591     # register target/source
1592     local target="$(java-pkg_get-target)"
1593     local source="$(java-pkg_get-source)"
1594     [[ -n ${target} ]] && echo "TARGET=\"${target}\"" >> "${JAVA_PKG_ENV}"
1595     [[ -n ${source} ]] && echo "SOURCE=\"${source}\"" >> "${JAVA_PKG_ENV}"
1596    
1597     # register javadoc info
1598     [[ -n ${JAVADOC_PATH} ]] && echo "JAVADOC_PATH=\"${JAVADOC_PATH}\"" \
1599     >> ${JAVA_PKG_ENV}
1600     # register source archives
1601     [[ -n ${JAVA_SOURCES} ]] && echo "JAVA_SOURCES=\"${JAVA_SOURCES}\"" \
1602     >> ${JAVA_PKG_ENV}
1603    
1604    
1605     echo "MERGE_VM=\"${GENTOO_VM}\"" >> "${JAVA_PKG_ENV}"
1606     [[ -n ${GENTOO_COMPILER} ]] && echo "MERGE_COMPILER=\"${GENTOO_COMPILER}\"" >> "${JAVA_PKG_ENV}"
1607    
1608     # Strip unnecessary leading and trailing colons
1609     # TODO try to cleanup if possible
1610     sed -e "s/=\":/=\"/" -e "s/:\"$/\"/" -i "${JAVA_PKG_ENV}" || die "Did you forget to call java_init ?"
1611     fi
1612     }
1613    
1614    
1615     # ------------------------------------------------------------------------------
1616     # @internal-function java-pkg_record-jar_
1617     #
1618     # Record a dependency to the package.env
1619     #
1620     # ------------------------------------------------------------------------------
1621     JAVA_PKG_DEPEND="${T}/java-pkg-depend"
1622    
1623     java-pkg_record-jar_() {
1624     debug-print-function ${FUNCNAME} $*
1625    
1626     local pkg=${1} jar=${2} append
1627     if [[ -z "${jar}" ]]; then
1628     append="${pkg}"
1629     else
1630     append="$(basename ${jar})@${pkg}"
1631     fi
1632    
1633     echo ${append} >> ${JAVA_PKG_DEPEND}
1634     }
1635    
1636     # ------------------------------------------------------------------------------
1637     # @internal-function java-pkg_append_
1638     #
1639     # Appends a value to a variable
1640     #
1641     # Example: java-pkg_append_ CLASSPATH foo.jar
1642     # @param $1 variable name to modify
1643     # @param $2 value to append
1644     # ------------------------------------------------------------------------------
1645     java-pkg_append_() {
1646     debug-print-function ${FUNCNAME} $*
1647    
1648     local var="${1}" value="${2}"
1649     if [[ -z "${!var}" ]] ; then
1650     export ${var}="${value}"
1651     else
1652     local oldIFS=${IFS} cur haveit
1653     IFS=':'
1654     for cur in ${!var}; do
1655     if [[ ${cur} == ${value} ]]; then
1656     haveit="yes"
1657     break
1658     fi
1659     done
1660     [[ -z ${haveit} ]] && export ${var}="${!var}:${value}"
1661     IFS=${oldIFS}
1662     fi
1663     }
1664    
1665     # ------------------------------------------------------------------------------
1666     # @internal-function java-pkg_expand_dir_
1667     #
1668     # Gets the full path of the file/directory's parent.
1669     # @param $1 - file/directory to find parent directory for
1670     # @return - path to $1's parent directory
1671     # ------------------------------------------------------------------------------
1672     java-pkg_expand_dir_() {
1673     pushd "$(dirname "${1}")" >/dev/null 2>&1
1674     pwd
1675     popd >/dev/null 2>&1
1676     }
1677    
1678     # ------------------------------------------------------------------------------
1679     # @internal-function java-pkg_func-exists
1680     #
1681     # Does the indicated function exist?
1682     #
1683     # @return 0 - function is declared
1684     # @return 1 - function is undeclared
1685     # ------------------------------------------------------------------------------
1686     java-pkg_func-exists() {
1687     if [[ -n "$(declare -f ${1})" ]]; then
1688     return 0
1689     else
1690     return 1
1691     fi
1692     }
1693    
1694     # ------------------------------------------------------------------------------
1695     # @internal-function java-pkg_setup-vm
1696     #
1697     # Sets up the environment for a specific VM
1698     #
1699     # ------------------------------------------------------------------------------
1700     java-pkg_setup-vm() {
1701     debug-print-function ${FUNCNAME} $*
1702    
1703     local vendor="$(java-pkg_get-vm-vendor)"
1704     if [[ "${vendor}" == "sun" ]] && java-pkg_is-vm-version-ge 1 5; then
1705     addpredict "/dev/random"
1706     elif [[ "${vendor}" == "ibm" ]]; then
1707     addpredict "/proc/self/maps"
1708     addpredict "/proc/cpuinfo"
1709     export LANG="C" LC_ALL="C"
1710     elif [[ "${vendor}" == "jrockit" ]]; then
1711     addpredict "/proc/cpuinfo"
1712     fi
1713     }
1714    
1715     # ------------------------------------------------------------------------------
1716     # @internal-function java-pkg_needs-vm
1717     #
1718     # Does the current package depend on virtual/jdk?
1719     #
1720     # @return 0 - Package depends on virtual/jdk
1721     # @return 1 - Package does not depend on virtual/jdk
1722     # ------------------------------------------------------------------------------
1723     java-pkg_needs-vm() {
1724     debug-print-function ${FUNCNAME} $*
1725    
1726     if [[ -n "$(echo ${DEPEND} | sed -e '\:virtual/jdk:!d')" ]]; then
1727     return 0
1728     fi
1729    
1730     return 1
1731     }
1732    
1733     # ------------------------------------------------------------------------------
1734     # @internal-function java-pkg_get-current-vm
1735     #
1736     # @return - The current VM being used
1737     # ------------------------------------------------------------------------------
1738     java-pkg_get-current-vm() {
1739     java-config -f
1740     }
1741    
1742     # ------------------------------------------------------------------------------
1743     # @internal-function java-pkg_get-vm-vendor
1744     #
1745     # @return - The vendor of the current VM
1746     # ------------------------------------------------------------------------------
1747     java-pkg_get-vm-vendor() {
1748     debug-print-function ${FUNCNAME} $*
1749    
1750     local vm="$(java-pkg_get-current-vm)"
1751     vm="${vm/-*/}"
1752     echo "${vm}"
1753     }
1754    
1755     # ------------------------------------------------------------------------------
1756     # @internal-function java-pkg_get-vm-version
1757     #
1758     # @return - The version of the current VM
1759     # ------------------------------------------------------------------------------
1760     java-pkg_get-vm-version() {
1761     debug-print-function ${FUNCNAME} $*
1762    
1763     java-pkg_get-current-vm | sed -e "s/.*-\([0-9.]\+\).*/\1/"
1764     }
1765    
1766     # ------------------------------------------------------------------------------
1767     # @internal-function java-pkg_switch-vm
1768     #
1769     # Switch VM if we're allowed to (controlled by JAVA_PKG_ALLOW_VM_CHANGE), and
1770     # verify that the current VM is sufficient.
1771     # Setup the environment for the VM being used.
1772     # ------------------------------------------------------------------------------
1773     java-pkg_switch-vm() {
1774     if java-pkg_needs-vm; then
1775     # Use the VM specified by JAVA_PKG_FORCE_VM
1776     if [[ -n ${JAVA_PKG_FORCE_VM} ]]; then
1777     # If you're forcing the VM, I hope you know what your doing...
1778     export GENTOO_VM="${JAVA_PKG_FORCE_VM}"
1779     # if we're allowed to switch the vm...
1780     elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then
1781     debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}} VNEED: ${JAVA_PKG_VNEED}"
1782     if [[ -n ${JAVA_PKG_VNEED} ]]; then
1783     export GENTOO_VM="$(depend-java-query --need-virtual "${JAVA_PKG_VNEED}" --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")"
1784     else
1785     export GENTOO_VM="$(depend-java-query --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")"
1786     fi
1787     # otherwise just make sure the current VM is sufficient
1788     else
1789     java-pkg_ensure-vm-version-sufficient
1790     fi
1791     debug-print "Using: $(java-config -f)"
1792    
1793     java-pkg_setup-vm
1794    
1795 nichoj 1.4 export JAVA=$(java-config --java)
1796     export JAVAC=$(java-config --javac)
1797 nichoj 1.1 export JAVACFLAGS="$(java-pkg_javac-args)"
1798     [[ -n ${JAVACFLAGS_EXTRA} ]] && export JAVACFLAGS="${JAVACFLAGS_EXTRA} ${JAVACFLAGS}"
1799    
1800     export JAVA_HOME="$(java-config -g JAVA_HOME)"
1801     export JDK_HOME=${JAVA_HOME}
1802    
1803     #TODO If you know a better solution let us know.
1804     java-pkg_append_ LD_LIBRARY_PATH "$(java-config -g LDPATH)"
1805    
1806     local tann="${T}/announced-vm"
1807     if [[ -n "${JAVA_PKG_DEBUG}" ]] || [[ ! -f "${tann}" ]] ; then
1808     # Add a check for setup/preinst phase... to avoid duplicate outputs
1809     # for when FEATURES=buildpkg
1810     if [[ ${EBUILD_PHASE} != "setup" && ${EBUILD_PHASE} != "preinst" && ${EBUILD_PHASE} != "postinst" ]];
1811     then
1812     einfo "Using: $(java-config -f)"
1813     [[ ! -f "${tann}" ]] && touch "${tann}"
1814     fi
1815     fi
1816    
1817     else
1818     [[ -n "${JAVA_PKG_DEBUG}" ]] && ewarn "!!! This package inherits java-pkg but doesn't depend on a JDK. -bin or broken dependency!!!"
1819     fi
1820     }
1821    
1822     # ------------------------------------------------------------------------------
1823     # @internal-function java-pkg_die
1824     #
1825     # Enhanced die for Java packages, which displays some information that may be
1826     # useful for debugging bugs on bugzilla.
1827     # ------------------------------------------------------------------------------
1828     #register_die_hook java-pkg_die
1829     if ! hasq java-pkg_die ${EBUILD_DEATH_HOOKS}; then
1830     EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die"
1831     fi
1832    
1833     java-pkg_die() {
1834     echo "!!! When you file a bug report, please include the following information:" >&2
1835     echo "GENTOO_VM=${GENTOO_VM} CLASSPATH=\"${CLASSPATH}\" JAVA_HOME=\"${JAVA_HOME}\"" >&2
1836     echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2
1837     echo "and of course, the output of emerge --info" >&2
1838     }
1839    
1840 nichoj 1.7
1841     # TODO document
1842     # List jars in the source directory, ${S}
1843     java-pkg_jar-list() {
1844     if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
1845     einfo "Linked Jars"
1846     find "${S}" -type l -name '*.jar' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
1847     einfo "Jars"
1848     find "${S}" -type f -name '*.jar' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
1849     einfo "Classes"
1850     find "${S}" -type f -name '*.class' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
1851     fi
1852     }
1853    
1854     # TODO document
1855     # Verify that the classes were compiled for the right source / target
1856     java-pkg_verify-classes() {
1857     ebegin "Verifying java class versions"
1858     #$(find ${D} -type f -name '*.jar' -o -name '*.class')
1859     class-version-verify.py -t $(java-pkg_get-target) -r ${D}
1860     result=$?
1861     eend ${result}
1862     if [[ ${result} == 0 ]]; then
1863     einfo "All good"
1864     else
1865     ewarn "Possible problem"
1866     die "Bad class files found"
1867     fi
1868     }
1869    
1870    
1871 nichoj 1.1 # ------------------------------------------------------------------------------
1872     # @section-end internal
1873     # ------------------------------------------------------------------------------
1874    
1875     java-pkg_check-phase() {
1876     local phase=${1}
1877     local funcname=${2}
1878 nichoj 1.9 if is-java-strict && [[ ${EBUILD_PHASE} != ${phase} ]]; then
1879 nichoj 1.1 java-pkg_announce-qa-violation \
1880     "${funcname} used outside of src_${phase}"
1881     fi
1882     }
1883    
1884     java-pkg_check-versioned-jar() {
1885     local jar=${1}
1886    
1887     if [[ ${jar} =~ ${PV} ]]; then
1888     java-pkg_announce-qa-violation "installing versioned jar '${jar}'"
1889     fi
1890     }
1891    
1892     java-pkg_check-jikes() {
1893     if hasq jikes ${IUSE}; then
1894     java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE"
1895     fi
1896     }
1897    
1898     java-pkg_announce-qa-violation() {
1899 nichoj 1.9 if is-java-strict; then
1900 nichoj 1.1 echo "Java QA Notice: $@" >&2
1901     increment-qa-violations
1902     fi
1903     }
1904    
1905     increment-qa-violations() {
1906     let "JAVA_PKG_QA_VIOLATIONS+=1"
1907     export JAVA_PKG_QA_VIOLATIONS
1908     }
1909    
1910 nichoj 1.9 is-java-strict() {
1911 nichoj 1.14 [[ -n ${JAVA_PKG_STRICT} ]]
1912 nichoj 1.9 return $?
1913     }
1914    
1915 nichoj 1.1 # ------------------------------------------------------------------------------
1916     # @eclass-end
1917     # ------------------------------------------------------------------------------

  ViewVC Help
Powered by ViewVC 1.1.20