/[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.23 - (hide annotations) (download)
Wed Sep 27 16:36:27 2006 UTC (7 years, 9 months ago) by caster
Branch: MAIN
Changes since 1.22: +1 -1 lines
Fixed a typo.

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 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     # -----------------------------------------------------------------------------
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 betelgeuse 1.19 # the version of java-config we want to use. We also need a recent version
46 nichoj 1.1 # 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 betelgeuse 1.19 #
106 nichoj 1.1 # 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 betelgeuse 1.19 # JAVA_PKG_COMPILERS_CONF.
126 nichoj 1.1 #
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 betelgeuse 1.19 # You should never install a jar with a package version in the filename.
156 nichoj 1.1 # 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 betelgeuse 1.19 #
228 nelchael 1.5 # 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 betelgeuse 1.19 #
311 nichoj 1.1 # 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 betelgeuse 1.19
376 nichoj 1.1 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 betelgeuse 1.19 # Installs a zip containing the source for a package, so it can used in
464 nichoj 1.1 # 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 betelgeuse 1.19 # TODO change so it the arguments it takes are the base directories containing
475 nichoj 1.1 # 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 betelgeuse 1.19 [ ${#} -lt 1 ] && die "At least one argument needed"
483 nichoj 1.1 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 betelgeuse 1.19 [[ ${#} -lt 1 ]] && die "At least one argument needed"
490 nichoj 1.1
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 betelgeuse 1.20 # --java_args 'Extra arguments to pass to java'
528     # --pkg_args 'Extra arguments too pass to the package'
529 nichoj 1.1 # --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 betelgeuse 1.20 local var_tmp="${T}/launcher_variables_tmp"
546 nichoj 1.1 local target_dir pre
547     shift
548    
549 betelgeuse 1.20 # Process the other the rest of the arguments
550 nichoj 1.1 while [[ -n "${1}" && -n "${2}" ]]; do
551     local var=${1} value=${2}
552 betelgeuse 1.19 if [[ "${var:0:2}" == "--" ]]; then
553 betelgeuse 1.20 echo "gjl_${var:2}=\"${value}\"" >> "${var_tmp}"
554 nichoj 1.1 elif [[ "${var}" == "-into" ]]; then
555     target_dir="${value}"
556     elif [[ "${var}" == "-pre" ]]; then
557     pre="${value}"
558     fi
559     shift 2
560     done
561 betelgeuse 1.20
562     # Write the actual script
563     echo "#!/bin/bash" > "${target}"
564     [[ -n "${pre}" ]] && [[ -f "${pre}" ]] && cat "${pre}" >> "${target}"
565 nichoj 1.1 echo "gjl_package=${JAVA_PKG_NAME}" >> "${target}"
566 betelgeuse 1.20 cat "${var_tmp}" >> "${target}"
567 caster 1.21 rm -f "${var_tmp}"
568 nichoj 1.1 echo "source /usr/share/java-config-2/launcher/launcher.bash" >> "${target}"
569 betelgeuse 1.19
570 nichoj 1.17 if [[ -n "${target_dir}" ]]; then
571 nichoj 1.1 DESTTREE="${target_dir}" dobin "${target}"
572     local ret=$?
573     return ${ret}
574     else
575     dobin "${target}"
576     fi
577     }
578    
579     # ------------------------------------------------------------------------------
580     # Install war files.
581     # TODO document
582     # ------------------------------------------------------------------------------
583     java-pkg_dowar() {
584     debug-print-function ${FUNCNAME} $*
585    
586     # Check for arguments
587     [[ ${#} -lt 1 ]] && die "At least one argument needed"
588     java-pkg_check-phase install
589    
590     java-pkg_init_paths_
591    
592     local war
593     for war in $* ; do
594     local warpath
595     # TODO evaluate if we want to handle symlinks differently -nichoj
596     # Check for symlink
597     if [[ -L "${war}" ]] ; then
598     cp "${war}" "${T}"
599     warpath="${T}$(basename "${war}")"
600     # Check for directory
601     # TODO evaluate if we want to handle directories differently -nichoj
602     elif [[ -d "${war}" ]] ; then
603     echo "dowar: warning, skipping directory ${war}"
604     continue
605     else
606     warpath="${war}"
607     fi
608 betelgeuse 1.18
609 nichoj 1.1 # Install those files like you mean it
610     INSOPTIONS="-m 0644" \
611     INSDESTTREE=${JAVA_PKG_WARDEST} \
612     doins ${warpath}
613     done
614     }
615    
616     # ------------------------------------------------------------------------------
617     # @internal-function java-pkg_recordjavadoc
618     # Scan for JavaDocs, and record their existence in the package.env file
619     #
620     # TODO make sure this in the proper section
621     # ------------------------------------------------------------------------------
622     java-pkg_recordjavadoc()
623     {
624     debug-print-function ${FUNCNAME} $*
625     # the find statement is important
626     # as some packages include multiple trees of javadoc
627     JAVADOC_PATH="$(find ${D}/usr/share/doc/ -name allclasses-frame.html -printf '%h:')"
628     # remove $D - TODO: check this is ok with all cases of the above
629     JAVADOC_PATH="${JAVADOC_PATH//${D}}"
630     if [[ -n "${JAVADOC_PATH}" ]] ; then
631     debug-print "javadocs found in ${JAVADOC_PATH%:}"
632     java-pkg_do_write_
633     else
634     debug-print "No javadocs found"
635     fi
636     }
637    
638     # ------------------------------------------------------------------------------
639     # @section-end install
640     # ------------------------------------------------------------------------------
641    
642     # ------------------------------------------------------------------------------
643     # @begin-section query
644     # Use these to build the classpath for building a package.
645     # ------------------------------------------------------------------------------
646    
647     # ------------------------------------------------------------------------------
648     # @ebuild-function java-pkg_jar-from
649     #
650     # Makes a symlink to a jar from a certain package
651     # A lot of java packages include dependencies in a lib/ directory
652     # You can use this function to replace these bundled dependencies.
653 nichoj 1.16 # The dependency is recorded into package.env DEPEND line, unless "--build-only"
654     # is passed as the very first argument, for jars that have to be present only
655     # at build time and are not needed on runtime (junit testing etc).
656 nichoj 1.1 #
657     # Example: get all jars from xerces slot 2
658     # java-pkg_jar-from xerces-2
659     # Example: get a specific jar from xerces slot 2
660     # java-pkg_jar-from xerces-2 xml-apis.jar
661 nichoj 1.16 # Example: get a specific jar from xerces slot 2, and name it diffrently
662 nichoj 1.1 # java-pkg_jar-from xerces-2 xml-apis.jar xml.jar
663 nichoj 1.16 # Example: get junit.jar which is needed only for building
664     # java-pkg_jar-from --build-only junit junit.jar
665 nichoj 1.1 #
666 nichoj 1.16 # @param $1 - (optional) "--build-only" makes the jar(s) not added into
667     # package.env DEPEND line.
668 nichoj 1.1 # @param $1 - Package to get jars from.
669     # @param $2 - jar from package. If not specified, all jars will be used.
670     # @param $3 - When a single jar is specified, destination filename of the
671     # symlink. Defaults to the name of the jar.
672     # ------------------------------------------------------------------------------
673     # TODO could probably be cleaned up a little
674     java-pkg_jar-from() {
675     debug-print-function ${FUNCNAME} $*
676    
677 nichoj 1.16 local build_only=""
678    
679     if [[ "${1}" = "--build-only" ]]; then
680     build_only="true"
681     shift
682     fi
683    
684 betelgeuse 1.18 local target_pkg="${1}" target_jar="${2}" destjar="${3}"
685    
686 nichoj 1.1 [[ -z ${target_pkg} ]] && die "Must specify a package"
687    
688     # default destjar to the target jar
689     [[ -z "${destjar}" ]] && destjar="${target_jar}"
690    
691 betelgeuse 1.18 local error_msg="There was a problem getting the classpath for ${target_pkg}."
692     local classpath
693     classpath="$(java-config --classpath=${target_pkg})"
694     [[ $? != 0 ]] && die ${error_msg}
695 nichoj 1.1
696     local jar
697     for jar in ${classpath//:/ }; do
698     local jar_name=$(basename "${jar}")
699     if [[ ! -f "${jar}" ]] ; then
700     debug-print "${jar} from ${target_pkg} does not exist"
701     die "Installation problems with jars in ${target_pkg} - is it installed?"
702     fi
703     # If no specific target jar was indicated, link it
704     if [[ -z "${target_jar}" ]] ; then
705     [[ -f "${target_jar}" ]] && rm "${target_jar}"
706     ln -snf "${jar}" \
707     || die "Failed to make symlink from ${jar} to ${jar_name}"
708 nichoj 1.16 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${target_pkg}" "${jar}"
709 nichoj 1.1 # otherwise, if the current jar is the target jar, link it
710     elif [[ "${jar_name}" == "${target_jar}" ]] ; then
711     [[ -f "${destjar}" ]] && rm "${destjar}"
712     ln -snf "${jar}" "${destjar}" \
713     || die "Failed to make symlink from ${jar} to ${destjar}"
714 nichoj 1.16 [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${target_pkg}" "${jar}"
715 nichoj 1.1 return 0
716     fi
717     done
718     # if no target was specified, we're ok
719     if [[ -z "${target_jar}" ]] ; then
720     return 0
721     # otherwise, die bitterly
722     else
723     die "Failed to find ${target_jar:-jar} in ${target_pkg}"
724     fi
725     }
726    
727     # ------------------------------------------------------------------------------
728     # @ebuild-function java-pkg_jarfrom
729     #
730     # See java-pkg_jar-from
731     # ------------------------------------------------------------------------------
732     java-pkg_jarfrom() {
733     java-pkg_jar-from "$@"
734     }
735    
736     # ------------------------------------------------------------------------------
737     # @ebuild-function java-pkg_getjars
738     #
739     # Get the classpath provided by any number of packages
740     # Among other things, this can be passed to 'javac -classpath' or 'ant -lib'.
741 nichoj 1.16 # The providing packages are recorded as dependencies into package.env DEPEND
742     # line, unless "--build-only" is passed as the very first argument, for jars
743     # that have to be present only at build time and are not needed on runtime
744     # (junit testing etc).
745 betelgeuse 1.19 #
746     # Example: Get the classpath for xerces-2,
747 nichoj 1.1 # java-pkg_getjars xerces-2 xalan
748     # Example Return:
749     # /usr/share/xerces-2/lib/xml-apis.jar:/usr/share/xerces-2/lib/xmlParserAPIs.jar:/usr/share/xalan/lib/xalan.jar
750 betelgeuse 1.19 #
751 nichoj 1.16 # @param $1 - (optional) "--build-only" makes the jar(s) not added into
752     # package.env DEPEND line.
753 nichoj 1.1 # @param $@ - list of packages to get jars from
754     # ------------------------------------------------------------------------------
755     java-pkg_getjars() {
756     debug-print-function ${FUNCNAME} $*
757    
758 nichoj 1.16 local build_only=""
759    
760     if [[ "${1}" = "--build-only" ]]; then
761     build_only="true"
762     shift
763     fi
764    
765 nichoj 1.1 [[ ${#} -lt 1 ]] && die "At least one argument needed"
766    
767     # NOTE could probably just pass $@ to java-config --classpath. and return it
768     local classpath pkg
769     for pkg in ${@//,/ }; do
770     #for pkg in $(echo "$@" | tr ',' ' '); do
771     jars="$(java-config --classpath=${pkg})"
772 betelgeuse 1.18 [[ -z "${jars}" ]] && die "java-config --classpath=${pkg} failed"
773 nichoj 1.1 debug-print "${pkg}:${jars}"
774 betelgeuse 1.18
775 nichoj 1.1 if [[ -z "${classpath}" ]]; then
776     classpath="${jars}"
777     else
778     classpath="${classpath}:${jars}"
779     fi
780 nichoj 1.16 # Only record jars that aren't build-only
781     [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${pkg}"
782 nichoj 1.1 done
783     echo "${classpath}"
784     }
785    
786     # ------------------------------------------------------------------------------
787     # @ebuild-function java-pkg_getjar
788     #
789     # Get the filename of a single jar from a package
790 nichoj 1.16 # The providing package is recorded as runtime dependency into package.env
791     # DEPEND line, unless "--build-only" is passed as the very first argument, for
792     # jars that have to be present only at build time and are not needed on runtime
793     # (junit testing etc).
794 nichoj 1.1 #
795     # @example
796     # java-pkg_getjar xerces-2 xml-apis.jar
797     # @example-return
798     # /usr/share/xerces-2/lib/xml-apis.jar
799 betelgeuse 1.19 #
800 nichoj 1.16 # @param $1 - (optional) "--build-only" makes the jar not added into
801     # package.env DEPEND line.
802 nichoj 1.1 # @param $1 - package to use
803     # @param $2 - jar to get
804     # ------------------------------------------------------------------------------
805     java-pkg_getjar() {
806     debug-print-function ${FUNCNAME} $*
807    
808 nichoj 1.16 local build_only=""
809    
810     if [[ "${1}" = "--build-only" ]]; then
811     build_only="true"
812     shift
813     fi
814    
815 nichoj 1.1 local pkg="${1}" target_jar="${2}" jar
816     [[ -z ${pkg} ]] && die "Must specify package to get a jar from"
817     [[ -z ${target_jar} ]] && die "Must specify jar to get"
818    
819 betelgeuse 1.18 local error_msg="Could not find classpath for ${pkg}. Are you sure its installed?"
820     local classpath
821     classpath=$(java-config --classpath=${pkg})
822     [[ $? != 0 ]] && die ${error_msg}
823    
824 nichoj 1.1 for jar in ${classpath//:/ }; do
825     if [[ ! -f "${jar}" ]] ; then
826 nichoj 1.16 die "Installation problem with jar ${jar} in ${pkg} - is it installed?"
827 nichoj 1.1 fi
828    
829     if [[ "$(basename ${jar})" == "${target_jar}" ]] ; then
830 nichoj 1.16 # Only record jars that aren't build-only
831     [[ -z "${build_only}" ]] && java-pkg_record-jar_ "${pkg}" "${jar}"
832 nichoj 1.1 echo "${jar}"
833     return 0
834     fi
835     done
836 betelgeuse 1.19
837 nichoj 1.1 die "Could not find ${target_jar} in ${pkg}"
838     return 1
839     }
840    
841     # This function reads stdin, and based on that input, figures out how to
842     # populate jars from the filesystem.
843     # Need to figure out a good way of making use of this, ie be able to use a
844     # string that was built instead of stdin
845     # NOTE: this isn't quite ready for primetime.
846     #java-pkg_populate-jars() {
847     # local line
848     #
849     # read line
850     # while [[ -n "${line}" ]]; do
851     # # Ignore comments
852     # [[ ${line%%#*} == "" ]] && continue
853     #
854     # # get rid of any spaces
855     # line="${line// /}"
856     #
857     # # format: path=jarinfo
858     # local path=${line%%=*}
859     # local jarinfo=${line##*=}
860 betelgeuse 1.19 #
861 nichoj 1.1 # # format: jar@package
862     # local jar=${jarinfo%%@*}.jar
863     # local package=${jarinfo##*@}
864     # if [[ -n ${replace_only} ]]; then
865     # [[ ! -f $path ]] && die "No jar exists at ${path}"
866     # fi
867     # if [[ -n ${create_parent} ]]; then
868     # local parent=$(dirname ${path})
869     # mkdir -p "${parent}"
870     # fi
871     # java-pkg_jar-from "${package}" "${jar}" "${path}"
872     #
873     # read line
874     # done
875     #}
876    
877     # ------------------------------------------------------------------------------
878     # @section-end query
879     # ------------------------------------------------------------------------------
880    
881     # ------------------------------------------------------------------------------
882     # @section-begin helper
883 betelgeuse 1.19 # @section-summary Helper functions
884 nichoj 1.1 #
885     # Various other functions to use from an ebuild
886     # ------------------------------------------------------------------------------
887    
888     # ------------------------------------------------------------------------------
889     # @ebuild-function java-pkg_need
890     #
891     # Adds virtual dependencies, which can optionally be controlled by a USE flag.
892     # Currently supported virtuals are:
893     # javamail
894     # jdbc-stdext
895     # jaf
896     # jdbc-rowset
897     # jms
898     #
899 betelgeuse 1.19 # @param $1 - Optionally indicate that the dependencies are controlled by
900 nichoj 1.1 # a use flag by specifying '--use' Requires $2.
901     # @param $2 - USE flag which will enable the dependencies.
902     # @param $@ - virtual packages to add depenedencies for
903     # ------------------------------------------------------------------------------
904     # TODO rewrite to parse a line based declaration file instead -- karltk
905     #java-pkg_need() {
906     # debug-print-function ${FUNCNAME} $*
907     # local useflag
908     # if [[ ${1} == "--use" ]]; then
909     # useflag="${2}"
910     # shift 2
911     # fi
912     #
913     # if [[ -z ${1} ]]; then
914     # die "Must specify at least one virtual package."
915     # fi
916     #
917     # local depstr newdepstr
918     #
919     # for virtual in ${@}; do
920     # if has ${virtual} ${JAVA_PKG_VNEED}; then
921     # debug-print "Already registered virtual ${virtual}"
922     # continue
923     # fi
924     # case ${virtual} in
925     # javamail)
926     # debug-print "java-pkg_need: adding javamail dependencies"
927     # newdepstr="|| ( dev-java/gnu-javamail dev-java/sun-javamail-bin )"
928     # ;;
929     # jdbc-stdext)
930     # debug-print "java-pkg_need: adding jdbc-stdext dependencies"
931     # newdepstr="|| ( >=virtual/jdk-1.4 dev-java/jdbc2-stdext )"
932     # ;;
933     # jaf)
934     # debug-print "java-pkg_need: adding jaf dependencies"
935     # newdepstr="|| ( dev-java/gnu-jaf dev-java/sun-jaf-bin )"
936     # ;;
937     # jdbc-rowset)
938     # debug-print "java-pkg_need: adding jdbc-rowset dependencies"
939     # newdepstr="|| ( >=virtual/jdk-1.5 dev-java/sun-jdbc-rowset )"
940     # ;;
941     # jms)
942     # debug-print "java-pkg_need: adding jms dependencies"
943     # newdepstr="|| ( dev-java/sun-jms dev-java/openjms )"
944     # ;;
945     # *)
946     # die "Invalid virtual: ${virtual}"
947     # esac
948     #
949     # export JAVA_PKG_VNEED="${JAVA_PKG_VNEED} ${virtual}"
950     #
951     # if [[ -n ${useflag} ]]; then
952     # depstr="${depstr} ${useflag}? ( ${newdepstr} )"
953     # else
954     # depstr="${depstr} ${newdepstr}"
955     # fi
956     # done
957     #
958     # [[ -z ${JAVA_PKG_NV_DEPEND} ]] && export JAVA_PKG_NV_DEPEND="${DEPEND}"
959     # [[ -z ${JAVA_PKG_NV_RDEPEND} ]] && export JAVA_PKG_NV_RDEPEND="${RDEPEND}"
960     #
961     # export DEPEND="${DEPEND} ${depstr}"
962     # export RDEPEND="${RDEPEND} ${depstr}"
963     #}
964    
965     # This should be used after S has been populated with symlinks to jars
966     # TODO document
967     java-pkg_ensure-no-bundled-jars() {
968     debug-print-function ${FUNCNAME} $*
969     pushd ${WORKDIR} >/dev/null 2>/dev/null
970    
971     local bundled_jars=$(find . -name "*.jar" -type f)
972     if [[ -n ${bundled_jars} ]]; then
973     echo "Bundled jars found:"
974     local jar
975     for jar in ${bundled_jars}; do
976     echo $(pwd)${jar/./}
977     done
978     die "Bundled jars found!"
979    
980     fi
981     popd >/dev/null 2>/dev/null
982     }
983    
984     # ------------------------------------------------------------------------------
985     # @internal-function java-pkg_ensure-vm-version-sufficient
986     #
987     # Checks if we have a sufficient VM and dies if we don't.
988     #
989     # ------------------------------------------------------------------------------
990     java-pkg_ensure-vm-version-sufficient() {
991     debug-print-function ${FUNCNAME} $*
992    
993     if ! java-pkg_is-vm-version-sufficient; then
994     debug-print "VM is not suffient"
995     eerror "Current Java VM cannot build this package"
996     einfo "Please use java-config -S to set the correct one"
997     die "Active Java VM cannot build this package"
998     fi
999     }
1000    
1001     # ------------------------------------------------------------------------------
1002     # @internal-function java-pkg_is-vm-version-sufficient
1003 betelgeuse 1.19 #
1004 nichoj 1.1 # @return zero - VM is sufficient
1005     # @return non-zero - VM is not sufficient
1006     # ------------------------------------------------------------------------------
1007     java-pkg_is-vm-version-sufficient() {
1008     debug-print-function ${FUNCNAME} $*
1009    
1010     depend-java-query --is-sufficient "${DEPEND}" > /dev/null
1011     return $?
1012     }
1013    
1014     # ------------------------------------------------------------------------------
1015     # @internal-function java-pkg_ensure-vm-version-eq
1016     #
1017     # Die if the current VM is not equal to the argument passed.
1018     #
1019     # @param $@ - Desired VM version to ensure
1020     # ------------------------------------------------------------------------------
1021     java-pkg_ensure-vm-version-eq() {
1022     debug-print-function ${FUNCNAME} $*
1023    
1024     if ! java-pkg_is-vm-version-eq $@ ; then
1025     debug-print "VM is not suffient"
1026     eerror "This package requires a Java VM version = $@"
1027     einfo "Please use java-config -S to set the correct one"
1028     die "Active Java VM too old"
1029     fi
1030     }
1031    
1032     # ------------------------------------------------------------------------------
1033 betelgeuse 1.19 # @internal-function java-pkg_is-vm-version-eq
1034     #
1035 nichoj 1.1 # @param $@ - VM version to compare current VM to
1036     # @return zero - VM versions are equal
1037     # @return non-zero - VM version are not equal
1038     # ------------------------------------------------------------------------------
1039     java-pkg_is-vm-version-eq() {
1040     debug-print-function ${FUNCNAME} $*
1041    
1042     local needed_version="$@"
1043    
1044     [[ -z "${needed_version}" ]] && die "need an argument"
1045    
1046     local vm_version="$(java-pkg_get-vm-version)"
1047    
1048     vm_version="$(get_version_component_range 1-2 "${vm_version}")"
1049     needed_version="$(get_version_component_range 1-2 "${needed_version}")"
1050    
1051     if [[ -z "${vm_version}" ]]; then
1052     debug-print "Could not get JDK version from DEPEND"
1053     return 1
1054     else
1055     if [[ "${vm_version}" == "${needed_version}" ]]; then
1056     debug-print "Detected a JDK(${vm_version}) = ${needed_version}"
1057     return 0
1058     else
1059     debug-print "Detected a JDK(${vm_version}) != ${needed_version}"
1060     return 1
1061     fi
1062     fi
1063     }
1064    
1065     # ------------------------------------------------------------------------------
1066     # @internal-function java-pkg_ensure-vm-version-ge
1067     #
1068     # Die if the current VM is not greater than the desired version
1069     #
1070     # @param $@ - VM version to compare current to
1071     # ------------------------------------------------------------------------------
1072     java-pkg_ensure-vm-version-ge() {
1073     debug-print-function ${FUNCNAME} $*
1074 betelgeuse 1.19
1075 nichoj 1.1 if ! java-pkg_is-vm-version-ge "$@" ; then
1076     debug-print "vm is not suffient"
1077     eerror "This package requires a Java VM version >= $@"
1078     einfo "Please use java-config -S to set the correct one"
1079     die "Active Java VM too old"
1080     fi
1081     }
1082    
1083     # ------------------------------------------------------------------------------
1084 betelgeuse 1.19 # @internal-function java-pkg_is-vm-version-ge
1085     #
1086 nichoj 1.1 # @param $@ - VM version to compare current VM to
1087     # @return zero - current VM version is greater than checked version
1088     # @return non-zero - current VM version is not greater than checked version
1089     # ------------------------------------------------------------------------------
1090     java-pkg_is-vm-version-ge() {
1091     debug-print-function ${FUNCNAME} $*
1092    
1093     local needed_version=$@
1094     local vm_version=$(java-pkg_get-vm-version)
1095     if [[ -z "${vm_version}" ]]; then
1096     debug-print "Could not get JDK version from DEPEND"
1097     return 1
1098     else
1099     if version_is_at_least "${needed_version}" "${vm_version}"; then
1100     debug-print "Detected a JDK(${vm_version}) >= ${needed_version}"
1101     return 0
1102     else
1103     debug-print "Detected a JDK(${vm_version}) < ${needed_version}"
1104     return 1
1105     fi
1106     fi
1107     }
1108    
1109 nichoj 1.12 java-pkg_set-current-vm() {
1110     export GENTOO_VM=${1}
1111     }
1112    
1113     java-pkg_get-current-vm() {
1114     echo ${GENTOO_VM}
1115     }
1116    
1117     java-pkg_current-vm-matches() {
1118 nichoj 1.15 hasq $(java-pkg_get-current-vm) ${@}
1119 nichoj 1.12 return $?
1120     }
1121    
1122 nichoj 1.1 # ------------------------------------------------------------------------------
1123     # @ebuild-function java-pkg_get-source
1124 betelgeuse 1.19 #
1125 nichoj 1.1 # Determines what source version should be used, for passing to -source.
1126     # Unless you want to break things you probably shouldn't set _WANT_SOURCE
1127     #
1128     # @return string - Either the lowest possible source, or JAVA_PKG_WANT_SOURCE
1129     # ------------------------------------------------------------------------------
1130     java-pkg_get-source() {
1131     echo ${JAVA_PKG_WANT_SOURCE:-$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")}
1132     }
1133    
1134     # ------------------------------------------------------------------------------
1135     # @ebuild-function java-pkg_get-target
1136     #
1137     # Determines what target version should be used, for passing to -target.
1138     # If you don't care about lower versions, you can set _WANT_TARGET to the
1139 betelgeuse 1.19 # version of your JDK.
1140 nichoj 1.1 # Remember doing this will mostly like cause things to break.
1141     # Doesn't allow it to be lower then the one in depend.
1142     # Doesn't allow it to be higher then the active vm.
1143     #
1144     # @return string - Either the lowest possible target, or JAVA_PKG_WANT_TARGET
1145     # ------------------------------------------------------------------------------
1146     java-pkg_get-target() {
1147 betelgeuse 1.19 local min=$(depend-java-query --get-lowest "${DEPEND} ${RDEPEND}")
1148 nichoj 1.1 if [[ -n "${JAVA_PKG_WANT_TARGET}" ]]; then
1149     local max="$(java-config --select-vm "${GENTOO_VM}" -g PROVIDES_VERSION)"
1150     if version_is_at_least "${min}" "${JAVA_PKG_WANT_TARGET}" && version_is_at_least "${JAVA_PKG_WANT_TARGET}" "${max}"; then
1151     echo ${JAVA_PKG_WANT_TARGET}
1152     else
1153     echo ${min}
1154     fi
1155     else
1156     echo ${min}
1157     fi
1158    
1159     #echo ${JAVA_PKG_WANT_TARGET:-$(depend-java-query --get-lowest "${DEPEND}")}
1160     }
1161    
1162     java-pkg_get-javac() {
1163     debug-print-function ${FUNCNAME} $*
1164    
1165     java-pkg_init-compiler_
1166     local compiler="${GENTOO_COMPILER}"
1167    
1168     local compiler_executable
1169     if [[ "${compiler}" = "javac" ]]; then
1170     # nothing fancy needs to be done for javac
1171     compiler_executable="javac"
1172     else
1173     # for everything else, try to determine from an env file
1174    
1175     local compiler_env="/usr/share/java-config-2/compiler/${compiler}"
1176     if [[ -f ${compiler_env} ]]; then
1177     local old_javac=${JAVAC}
1178     unset JAVAC
1179     # try to get value of JAVAC
1180     compiler_executable="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${JAVAC})"
1181     export JAVAC=${old_javac}
1182    
1183     [[ -z ${compiler_executable} ]] && die "JAVAC is empty or undefined in ${compiler_env}"
1184 betelgeuse 1.19
1185 nichoj 1.1 # check that it's executable
1186     if [[ ! -x ${compiler_executable} ]]; then
1187     eerror "Could not find ${compiler_executable}!"
1188     die "${compiler_executable} doesn't exist, or isn't executable"
1189     fi
1190     else
1191     eerror "Could not find environment file for ${compiler}"
1192     die "Could not find ${compiler_env}"
1193     fi
1194     fi
1195     echo ${compiler_executable}
1196     }
1197    
1198     # ------------------------------------------------------------------------------
1199 betelgeuse 1.19 # @ebuild-function java-pkg_javac-args
1200 nichoj 1.1 #
1201     # If an ebuild uses javac directly, instead of using ejavac, it should call this
1202     # to know what -source/-target to use.
1203     #
1204     # @return string - arguments to pass to javac, complete with -target and -source
1205     # ------------------------------------------------------------------------------
1206     java-pkg_javac-args() {
1207     debug-print-function ${FUNCNAME} $*
1208    
1209     local want_source="$(java-pkg_get-source)"
1210     local want_target="$(java-pkg_get-target)"
1211    
1212 betelgeuse 1.19 local source_str="-source ${want_source}"
1213 nichoj 1.1 local target_str="-target ${want_target}"
1214    
1215     debug-print "want source: ${want_source}"
1216     debug-print "want target: ${want_target}"
1217    
1218     if [[ -z "${want_source}" || -z "${want_target}" ]]; then
1219     debug-print "could not find valid -source/-target values"
1220     die "Could not find valid -source/-target values"
1221     else
1222     if java-pkg_is-vm-version-ge "1.4"; then
1223     echo "${source_str} ${target_str}"
1224     else
1225     echo "${target_str}"
1226     fi
1227     fi
1228     }
1229    
1230     # TODO document
1231     java-pkg_get-jni-cflags() {
1232     local flags="-I${JAVA_HOME}/include"
1233    
1234 nichoj 1.10 # TODO do a check that the directories are valid
1235 nichoj 1.1 # TODO figure out how to cope with other things than linux...
1236     flags="${flags} -I${JAVA_HOME}/include/linux"
1237    
1238     echo ${flags}
1239     }
1240    
1241 nichoj 1.10 java-pkg_ensure-gcj() {
1242     if ! built_with_use sys-devel/gcc gcj ; then
1243     ewarn
1244     ewarn "You must build gcc with the gcj support to build with gcj"
1245     ewarn
1246     ebeep 5
1247     die "No GCJ support found!"
1248     fi
1249     }
1250    
1251 nichoj 1.13 java-pkg_ensure-test() {
1252     if hasq test ${FEATURES} && ! hasq -test ${FEATURES} && ! use test; then
1253     eerror "You specified FEATURES=test, but USE=test is needed"
1254     eerror "to pull in the additional dependencies for testing"
1255     die "Need USE=test enabled"
1256     fi
1257     }
1258    
1259 nichoj 1.1 # ------------------------------------------------------------------------------
1260     # @section-end helper
1261     # ------------------------------------------------------------------------------
1262    
1263     # ------------------------------------------------------------------------------
1264     # @section-begin build
1265     # @section-summary Build functions
1266     #
1267     # These are some functions for building a package. In particular, it consists of
1268     # wrappers for javac and ant.
1269     # ------------------------------------------------------------------------------
1270    
1271     # ------------------------------------------------------------------------------
1272     # @ebuild-function eant
1273     #
1274     # Ant wrapper function. Will use the appropriate compiler, based on user-defined
1275     # compiler.
1276     #
1277     # ------------------------------------------------------------------------------
1278     eant() {
1279     debug-print-function ${FUNCNAME} $*
1280    
1281 nichoj 1.12 # FIXME get this working
1282     # if is-java-strict && [[ ! ${DEPEND} =~ "dev-java/ant" ]]; then
1283     # java-pkg_announce-qa-violation \
1284     # "Using eant, but not depending on dev-java/ant or dev-java/ant-core"
1285     # fi
1286    
1287 nichoj 1.1 local antflags
1288     java-pkg_init-compiler_
1289     local compiler="${GENTOO_COMPILER}"
1290    
1291     local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1292    
1293     local build_compiler="$(source ${compiler_env} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER})"
1294     if [[ "${compiler}" != "javac" && -z "${build_compiler}" ]]; then
1295     die "ANT_BUILD_COMPILER undefined in ${compiler_env}"
1296     fi
1297    
1298     if [[ ${compiler} != "javac" ]]; then
1299     antflags="-Dbuild.compiler=${build_compiler}"
1300     # Figure out any extra stuff to put on the classpath for compilers aside
1301     # from javac
1302     # ANT_BUILD_COMPILER_DEPS should be something that could be passed to
1303     # java-config -p
1304     local build_compiler_deps="$(source ${JAVA_PKG_COMPILER_DIR}/${compiler} 1>/dev/null 2>&1; echo ${ANT_BUILD_COMPILER_DEPS})"
1305     if [[ -n ${build_compiler_deps} ]]; then
1306     antflags="${antflags} -lib $(java-config -p ${build_compiler_deps})"
1307     fi
1308     fi
1309 nichoj 1.9
1310     if is-java-strict; then
1311     einfo "Disabling system classpath for ant"
1312     antflags="${antflags} -Dbuild.sysclasspath=ignore"
1313     fi
1314 betelgeuse 1.19
1315 nichoj 1.1 if [[ -n ${JAVA_PKG_DEBUG} ]]; then
1316     antflags="${antflags} -debug"
1317     fi
1318 betelgeuse 1.19
1319 nichoj 1.1 [[ -n ${JAVA_PKG_DEBUG} ]] && echo ant ${antflags} "${@}"
1320     ant ${antflags} "${@}" || die "eant failed"
1321    
1322     }
1323    
1324     # ------------------------------------------------------------------------------
1325     # @ebuild-function ejavac
1326     #
1327 betelgeuse 1.19 # Javac wrapper function. Will use the appropriate compiler, based on
1328 nichoj 1.1 # /etc/java-config/compilers.conf
1329     #
1330     # @param $@ - Arguments to be passed to the compiler
1331     # ------------------------------------------------------------------------------
1332     ejavac() {
1333     debug-print-function ${FUNCNAME} $*
1334    
1335 nichoj 1.6 # FIXME using get-javac ends up printing stuff with einfo
1336     # local compiler_executable=$(java-pkg_get-javac)
1337     local compiler_executable="javac"
1338 nichoj 1.1
1339     [[ -n ${JAVA_PKG_DEBUG} ]] && echo ${compiler_executable} $(java-pkg_javac-args) "${@}"
1340     ${compiler_executable} $(java-pkg_javac-args) "${@}" || die "ejavac failed"
1341     }
1342    
1343     # ------------------------------------------------------------------------------
1344     # @ebuild-function java-pkg_filter-compiler
1345 betelgeuse 1.19 #
1346 nichoj 1.1 # Used to prevent the use of some compilers. Should be used in src_compile.
1347     # Basically, it just appends onto JAVA_PKG_FILTER_COMPILER
1348     #
1349     # @param $@ - compilers to filter
1350     # ------------------------------------------------------------------------------
1351     java-pkg_filter-compiler() {
1352     JAVA_PKG_FILTER_COMPILER="${JAVA_PKG_FILTER_COMPILER} $@"
1353     }
1354    
1355     # ------------------------------------------------------------------------------
1356 nichoj 1.8 # @ebuild-function java-pkg_force-compiler
1357     #
1358     # Used to force the use of particular compilers. Should be used in src_compile.
1359     # A common use of this would be to force ecj-3.1 to be used on amd64, to avoid
1360     # OutOfMemoryErrors that may come up.
1361     #
1362     # @param $@ - compilers to force
1363     # ------------------------------------------------------------------------------
1364     java-pkg_force-compiler() {
1365     JAVA_PKG_FORCE_COMPILER="$@"
1366     }
1367    
1368     # ------------------------------------------------------------------------------
1369 nichoj 1.1 # @ebuild-function use_doc
1370     #
1371     # Helper function for getting ant to build javadocs. If the user has USE=doc,
1372     # then 'javadoc' or the argument are returned. Otherwise, there is no return.
1373 betelgeuse 1.19 #
1374 nichoj 1.1 # The output of this should be passed to ant.
1375     #
1376     # Example: build javadocs by calling 'javadoc' target
1377     # eant $(use_doc)
1378     # Example: build javadocs by calling 'apidoc' target
1379     # eant $(use_doc apidoc)
1380     #
1381     # @param $@ - Option value to return. Defaults to 'javadoc'
1382     # @return string - Name of the target to create javadocs
1383     # ------------------------------------------------------------------------------
1384     use_doc() {
1385     use doc && echo ${@:-javadoc}
1386     }
1387    
1388     # ------------------------------------------------------------------------------
1389     # @section-end build
1390     # ------------------------------------------------------------------------------
1391 betelgeuse 1.19
1392 nichoj 1.1 # ------------------------------------------------------------------------------
1393     # @section-begin internal
1394 betelgeuse 1.19 # @section-summary Internal functions
1395 nichoj 1.1 #
1396     # Do __NOT__ use any of these from an ebuild! These are only to be used from
1397     # within the java eclasses.
1398     # ------------------------------------------------------------------------------
1399    
1400     # -----------------------------------------------------------------------------
1401     # @function-internal java-pkg_init
1402 betelgeuse 1.19 #
1403 nichoj 1.1 # The purpose of this function, as the name might imply, is to initialize the
1404     # Java environment. It ensures that that there aren't any environment variables
1405     # that'll muss things up. It initializes some variables, which are used
1406     # internally. And most importantly, it'll switch the VM if necessary.
1407     #
1408     # This shouldn't be used directly. Instead, java-pkg and java-pkg-opt will
1409     # call it during each of the phases of the merge process.
1410     #
1411     # -----------------------------------------------------------------------------
1412     java-pkg_init() {
1413     unset JAVAC
1414     unset JAVA_HOME
1415     java-pkg_init_paths_
1416     java-pkg_switch-vm
1417     PATH=${JAVA_HOME}/bin:${PATH}
1418    
1419     # TODO we will probably want to set JAVAC and JAVACFLAGS
1420    
1421     # Do some QA checks
1422     java-pkg_check-jikes
1423    
1424 betelgeuse 1.19 # When users have crazy classpaths some packages can fail to compile.
1425 nichoj 1.1 # and everything should work with empty CLASSPATH.
1426     # This also helps prevent unexpected dependencies on random things
1427     # from the CLASSPATH.
1428 betelgeuse 1.19 unset CLASSPATH
1429 nichoj 1.1 }
1430    
1431     # ------------------------------------------------------------------------------
1432     # @function-internal java-pkg-init-compiler_
1433     #
1434     # This function attempts to figure out what compiler should be used. It does
1435 betelgeuse 1.19 # this by reading the file at JAVA_PKG_COMPILERS_CONF, and checking the
1436 nichoj 1.1 # COMPILERS variable defined there.
1437     # This can be overridden by a list in JAVA_PKG_FORCE_COMPILER
1438 betelgeuse 1.19 #
1439 nichoj 1.1 # It will go through the list of compilers, and verify that it supports the
1440     # target and source that are needed. If it is not suitable, then the next
1441     # compiler is checked. When JAVA_PKG_FORCE_COMPILER is defined, this checking
1442     # isn't done.
1443     #
1444     # Once the which compiler to use has been figured out, it is set to
1445     # GENTOO_COMPILER.
1446     #
1447     # If you hadn't guessed, JAVA_PKG_FORCE_COMPILER is for testing only.
1448     #
1449     # If the user doesn't defined anything in JAVA_PKG_COMPILERS_CONF, or no
1450     # suitable compiler was found there, then the default is to use javac provided
1451     # by the current VM.
1452     #
1453     #
1454     # @return name of the compiler to use
1455     # ------------------------------------------------------------------------------
1456     java-pkg_init-compiler_() {
1457     debug-print-function ${FUNCNAME} $*
1458    
1459     if [[ -n ${GENTOO_COMPILER} ]]; then
1460     debug-print "GENTOO_COMPILER already set"
1461     return
1462     fi
1463    
1464 nichoj 1.3 local compilers;
1465     if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
1466     compilers="$(source ${JAVA_PKG_COMPILERS_CONF} 1>/dev/null 2>&1; echo ${COMPILERS})"
1467     else
1468     compilers=${JAVA_PKG_FORCE_COMPILER}
1469     fi
1470 betelgeuse 1.19
1471 nichoj 1.1 debug-print "Read \"${compilers}\" from ${JAVA_PKG_COMPILERS_CONF}"
1472    
1473     # Figure out if we should announce what compiler we're using
1474     local compiler
1475     for compiler in ${compilers}; do
1476     debug-print "Checking ${compiler}..."
1477     # javac should always be alright
1478     if [[ ${compiler} = "javac" ]]; then
1479     debug-print "Found javac... breaking"
1480     export GENTOO_COMPILER="javac"
1481     break
1482     fi
1483 betelgeuse 1.19
1484 nichoj 1.1 if has ${compiler} ${JAVA_PKG_FILTER_COMPILER}; then
1485     if [[ -z ${JAVA_PKG_FORCE_COMPILER} ]]; then
1486     einfo "Filtering ${compiler}"
1487     continue
1488     fi
1489     fi
1490 betelgeuse 1.19
1491 nichoj 1.1 # for non-javac, we need to make sure it supports the right target and
1492     # source
1493     local compiler_env="${JAVA_PKG_COMPILER_DIR}/${compiler}"
1494     if [[ -f ${compiler_env} ]]; then
1495     local desired_target="$(java-pkg_get-target)"
1496     local desired_source="$(java-pkg_get-source)"
1497    
1498    
1499     # Verify that the compiler supports target
1500     local supported_target=$(source ${compiler_env} 1>/dev/null 2>&1; echo ${SUPPORTED_TARGET})
1501     if ! has ${desired_target} ${supported_target}; then
1502     ewarn "${compiler} does not support -target ${desired_target}, skipping"
1503     continue
1504     fi
1505    
1506     # -source was introduced in 1.3, so only check 1.3 and on
1507     if version_is_at_least "${desired_soure}" "1.3"; then
1508     # Verify that the compiler supports source
1509     local supported_source=$(source ${compiler_env} 1>/dev/null 2>&1; echo ${SUPPORTED_SOURCE})
1510     if ! has ${desired_source} ${supported_source}; then
1511     ewarn "${compiler} does not support -source ${desired_source}, skipping"
1512     continue
1513     fi
1514     fi
1515    
1516     # if you get here, then the compiler should be good to go
1517     export GENTOO_COMPILER="${compiler}"
1518     break
1519     else
1520     ewarn "Could not find configuration for ${compiler}, skipping"
1521     ewarn "Perhaps it is not installed?"
1522     continue
1523     fi
1524     done
1525    
1526     # If it hasn't been defined already, default to javac
1527     if [[ -z ${GENTOO_COMPILER} ]]; then
1528     if [[ -n ${compilers} ]]; then
1529     einfo "No suitable compiler found: defaulting javac for compilation"
1530     else
1531     # probably don't need to notify users about the default.
1532     :;#einfo "Defaulting to javac for compilation"
1533     fi
1534     export GENTOO_COMPILER=javac
1535     else
1536     einfo "Using ${GENTOO_COMPILER} for compilation"
1537     fi
1538    
1539     }
1540    
1541     # ------------------------------------------------------------------------------
1542     # @internal-function init_paths_
1543     #
1544     # Initializes some variables that will be used. These variables are mostly used
1545     # to determine where things will eventually get installed.
1546     # ------------------------------------------------------------------------------
1547     java-pkg_init_paths_() {
1548     debug-print-function ${FUNCNAME} $*
1549    
1550     local pkg_name
1551     if [[ "$SLOT" == "0" ]] ; then
1552     JAVA_PKG_NAME="${PN}"
1553     else
1554     JAVA_PKG_NAME="${PN}-${SLOT}"
1555     fi
1556    
1557     JAVA_PKG_SHAREPATH="${DESTTREE}/share/${JAVA_PKG_NAME}"
1558     JAVA_PKG_SOURCESPATH="${JAVA_PKG_SHAREPATH}/sources/"
1559     JAVA_PKG_ENV="${D}${JAVA_PKG_SHAREPATH}/package.env"
1560    
1561     [[ -z "${JAVA_PKG_JARDEST}" ]] && JAVA_PKG_JARDEST="${JAVA_PKG_SHAREPATH}/lib"
1562     [[ -z "${JAVA_PKG_LIBDEST}" ]] && JAVA_PKG_LIBDEST="${DESTTREE}/$(get_libdir)/${JAVA_PKG_NAME}"
1563     [[ -z "${JAVA_PKG_WARDEST}" ]] && JAVA_PKG_WARDEST="${JAVA_PKG_SHAREPATH}/webapps"
1564    
1565    
1566     # TODO maybe only print once?
1567     debug-print "JAVA_PKG_SHAREPATH: ${JAVA_PKG_SHAREPATH}"
1568     debug-print "JAVA_PKG_ENV: ${JAVA_PKG_ENV}"
1569     debug-print "JAVA_PKG_JARDEST: ${JAVA_PKG_JARDEST}"
1570     debug-print "JAVA_PKG_LIBDEST: ${JAVA_PKG_LIBDEST}"
1571     debug-print "JAVA_PKG_WARDEST: ${JAVA_PKG_WARDEST}"
1572     }
1573    
1574     # ------------------------------------------------------------------------------
1575     # @internal-function java-pkg_do_write_
1576     #
1577     # Writes the package.env out to disk.
1578     #
1579     # ------------------------------------------------------------------------------
1580     # TODO change to do-write, to match everything else
1581     java-pkg_do_write_() {
1582     # Create directory for package.env
1583     dodir "${JAVA_PKG_SHAREPATH}"
1584     if [[ -n "${JAVA_PKG_CLASSPATH}" || -n "${JAVA_PKG_LIBRARY}" || -f "${JAVA_PKG_DEPEND}" ]]; then
1585     # Create package.env
1586     (
1587     echo "DESCRIPTION=\"${DESCRIPTION}\""
1588     echo "GENERATION=\"2\""
1589    
1590     [[ -n "${JAVA_PKG_CLASSPATH}" ]] && echo "CLASSPATH=\"${JAVA_PKG_CLASSPATH}\""
1591     [[ -n "${JAVA_PKG_LIBRARY}" ]] && echo "LIBRARY_PATH=\"${JAVA_PKG_LIBRARY}\""
1592     [[ -n "${JAVA_PROVIDE}" ]] && echo "PROVIDES=\"${JAVA_PROVIDE}\""
1593     [[ -f "${JAVA_PKG_DEPEND}" ]] && echo "DEPEND=\"$(cat ${JAVA_PKG_DEPEND} | uniq | tr '\n' ':')\""
1594     echo "VM=\"$(echo ${RDEPEND} ${DEPEND} | sed -e 's/ /\n/g' | sed -n -e '/virtual\/\(jre\|jdk\)/ { p;q }')\"" # TODO cleanup !
1595     ) > "${JAVA_PKG_ENV}"
1596 betelgeuse 1.19
1597 nichoj 1.1 # register target/source
1598     local target="$(java-pkg_get-target)"
1599     local source="$(java-pkg_get-source)"
1600     [[ -n ${target} ]] && echo "TARGET=\"${target}\"" >> "${JAVA_PKG_ENV}"
1601     [[ -n ${source} ]] && echo "SOURCE=\"${source}\"" >> "${JAVA_PKG_ENV}"
1602    
1603     # register javadoc info
1604     [[ -n ${JAVADOC_PATH} ]] && echo "JAVADOC_PATH=\"${JAVADOC_PATH}\"" \
1605     >> ${JAVA_PKG_ENV}
1606     # register source archives
1607     [[ -n ${JAVA_SOURCES} ]] && echo "JAVA_SOURCES=\"${JAVA_SOURCES}\"" \
1608     >> ${JAVA_PKG_ENV}
1609    
1610    
1611     echo "MERGE_VM=\"${GENTOO_VM}\"" >> "${JAVA_PKG_ENV}"
1612     [[ -n ${GENTOO_COMPILER} ]] && echo "MERGE_COMPILER=\"${GENTOO_COMPILER}\"" >> "${JAVA_PKG_ENV}"
1613    
1614     # Strip unnecessary leading and trailing colons
1615     # TODO try to cleanup if possible
1616     sed -e "s/=\":/=\"/" -e "s/:\"$/\"/" -i "${JAVA_PKG_ENV}" || die "Did you forget to call java_init ?"
1617     fi
1618     }
1619    
1620    
1621     # ------------------------------------------------------------------------------
1622     # @internal-function java-pkg_record-jar_
1623     #
1624     # Record a dependency to the package.env
1625     #
1626     # ------------------------------------------------------------------------------
1627     JAVA_PKG_DEPEND="${T}/java-pkg-depend"
1628    
1629     java-pkg_record-jar_() {
1630     debug-print-function ${FUNCNAME} $*
1631    
1632     local pkg=${1} jar=${2} append
1633     if [[ -z "${jar}" ]]; then
1634     append="${pkg}"
1635     else
1636     append="$(basename ${jar})@${pkg}"
1637     fi
1638    
1639     echo ${append} >> ${JAVA_PKG_DEPEND}
1640     }
1641    
1642     # ------------------------------------------------------------------------------
1643     # @internal-function java-pkg_append_
1644     #
1645     # Appends a value to a variable
1646     #
1647     # Example: java-pkg_append_ CLASSPATH foo.jar
1648     # @param $1 variable name to modify
1649     # @param $2 value to append
1650     # ------------------------------------------------------------------------------
1651     java-pkg_append_() {
1652     debug-print-function ${FUNCNAME} $*
1653    
1654     local var="${1}" value="${2}"
1655     if [[ -z "${!var}" ]] ; then
1656     export ${var}="${value}"
1657     else
1658     local oldIFS=${IFS} cur haveit
1659     IFS=':'
1660     for cur in ${!var}; do
1661     if [[ ${cur} == ${value} ]]; then
1662     haveit="yes"
1663     break
1664     fi
1665     done
1666     [[ -z ${haveit} ]] && export ${var}="${!var}:${value}"
1667     IFS=${oldIFS}
1668     fi
1669     }
1670    
1671     # ------------------------------------------------------------------------------
1672     # @internal-function java-pkg_expand_dir_
1673 betelgeuse 1.19 #
1674 nichoj 1.1 # Gets the full path of the file/directory's parent.
1675     # @param $1 - file/directory to find parent directory for
1676     # @return - path to $1's parent directory
1677     # ------------------------------------------------------------------------------
1678     java-pkg_expand_dir_() {
1679     pushd "$(dirname "${1}")" >/dev/null 2>&1
1680     pwd
1681     popd >/dev/null 2>&1
1682     }
1683    
1684     # ------------------------------------------------------------------------------
1685     # @internal-function java-pkg_func-exists
1686     #
1687     # Does the indicated function exist?
1688     #
1689     # @return 0 - function is declared
1690     # @return 1 - function is undeclared
1691     # ------------------------------------------------------------------------------
1692     java-pkg_func-exists() {
1693     if [[ -n "$(declare -f ${1})" ]]; then
1694     return 0
1695     else
1696     return 1
1697     fi
1698     }
1699    
1700     # ------------------------------------------------------------------------------
1701     # @internal-function java-pkg_setup-vm
1702     #
1703     # Sets up the environment for a specific VM
1704     #
1705     # ------------------------------------------------------------------------------
1706     java-pkg_setup-vm() {
1707     debug-print-function ${FUNCNAME} $*
1708    
1709     local vendor="$(java-pkg_get-vm-vendor)"
1710 caster 1.23 if [[ "${vendor}" == "sun" ]] && java-pkg_is-vm-version-ge "1.5" ; then
1711 nichoj 1.1 addpredict "/dev/random"
1712     elif [[ "${vendor}" == "ibm" ]]; then
1713     addpredict "/proc/self/maps"
1714     addpredict "/proc/cpuinfo"
1715     export LANG="C" LC_ALL="C"
1716     elif [[ "${vendor}" == "jrockit" ]]; then
1717     addpredict "/proc/cpuinfo"
1718     fi
1719     }
1720    
1721     # ------------------------------------------------------------------------------
1722     # @internal-function java-pkg_needs-vm
1723     #
1724     # Does the current package depend on virtual/jdk?
1725     #
1726     # @return 0 - Package depends on virtual/jdk
1727     # @return 1 - Package does not depend on virtual/jdk
1728     # ------------------------------------------------------------------------------
1729     java-pkg_needs-vm() {
1730     debug-print-function ${FUNCNAME} $*
1731    
1732     if [[ -n "$(echo ${DEPEND} | sed -e '\:virtual/jdk:!d')" ]]; then
1733     return 0
1734     fi
1735    
1736     return 1
1737     }
1738    
1739     # ------------------------------------------------------------------------------
1740     # @internal-function java-pkg_get-current-vm
1741     #
1742     # @return - The current VM being used
1743     # ------------------------------------------------------------------------------
1744     java-pkg_get-current-vm() {
1745     java-config -f
1746     }
1747    
1748     # ------------------------------------------------------------------------------
1749     # @internal-function java-pkg_get-vm-vendor
1750     #
1751     # @return - The vendor of the current VM
1752     # ------------------------------------------------------------------------------
1753     java-pkg_get-vm-vendor() {
1754     debug-print-function ${FUNCNAME} $*
1755    
1756     local vm="$(java-pkg_get-current-vm)"
1757     vm="${vm/-*/}"
1758     echo "${vm}"
1759     }
1760    
1761     # ------------------------------------------------------------------------------
1762     # @internal-function java-pkg_get-vm-version
1763     #
1764     # @return - The version of the current VM
1765     # ------------------------------------------------------------------------------
1766     java-pkg_get-vm-version() {
1767     debug-print-function ${FUNCNAME} $*
1768    
1769 caster 1.22 java-config -g PROVIDES_VERSION
1770 nichoj 1.1 }
1771    
1772     # ------------------------------------------------------------------------------
1773     # @internal-function java-pkg_switch-vm
1774     #
1775 betelgeuse 1.19 # Switch VM if we're allowed to (controlled by JAVA_PKG_ALLOW_VM_CHANGE), and
1776 nichoj 1.1 # verify that the current VM is sufficient.
1777     # Setup the environment for the VM being used.
1778     # ------------------------------------------------------------------------------
1779     java-pkg_switch-vm() {
1780     if java-pkg_needs-vm; then
1781     # Use the VM specified by JAVA_PKG_FORCE_VM
1782     if [[ -n ${JAVA_PKG_FORCE_VM} ]]; then
1783     # If you're forcing the VM, I hope you know what your doing...
1784     export GENTOO_VM="${JAVA_PKG_FORCE_VM}"
1785     # if we're allowed to switch the vm...
1786     elif [[ "${JAVA_PKG_ALLOW_VM_CHANGE}" == "yes" ]]; then
1787     debug-print "depend-java-query: NV_DEPEND: ${JAVA_PKG_NV_DEPEND:-${DEPEND}} VNEED: ${JAVA_PKG_VNEED}"
1788     if [[ -n ${JAVA_PKG_VNEED} ]]; then
1789     export GENTOO_VM="$(depend-java-query --need-virtual "${JAVA_PKG_VNEED}" --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")"
1790     else
1791     export GENTOO_VM="$(depend-java-query --get-vm "${JAVA_PKG_NV_DEPEND:-${DEPEND}}")"
1792     fi
1793     # otherwise just make sure the current VM is sufficient
1794     else
1795     java-pkg_ensure-vm-version-sufficient
1796     fi
1797     debug-print "Using: $(java-config -f)"
1798 betelgeuse 1.19
1799 nichoj 1.1 java-pkg_setup-vm
1800    
1801 nichoj 1.4 export JAVA=$(java-config --java)
1802     export JAVAC=$(java-config --javac)
1803 betelgeuse 1.19 export JAVACFLAGS="$(java-pkg_javac-args)"
1804 nichoj 1.1 [[ -n ${JAVACFLAGS_EXTRA} ]] && export JAVACFLAGS="${JAVACFLAGS_EXTRA} ${JAVACFLAGS}"
1805    
1806     export JAVA_HOME="$(java-config -g JAVA_HOME)"
1807     export JDK_HOME=${JAVA_HOME}
1808    
1809     #TODO If you know a better solution let us know.
1810     java-pkg_append_ LD_LIBRARY_PATH "$(java-config -g LDPATH)"
1811 betelgeuse 1.19
1812 nichoj 1.1 local tann="${T}/announced-vm"
1813     if [[ -n "${JAVA_PKG_DEBUG}" ]] || [[ ! -f "${tann}" ]] ; then
1814     # Add a check for setup/preinst phase... to avoid duplicate outputs
1815     # for when FEATURES=buildpkg
1816     if [[ ${EBUILD_PHASE} != "setup" && ${EBUILD_PHASE} != "preinst" && ${EBUILD_PHASE} != "postinst" ]];
1817     then
1818     einfo "Using: $(java-config -f)"
1819     [[ ! -f "${tann}" ]] && touch "${tann}"
1820     fi
1821     fi
1822    
1823     else
1824     [[ -n "${JAVA_PKG_DEBUG}" ]] && ewarn "!!! This package inherits java-pkg but doesn't depend on a JDK. -bin or broken dependency!!!"
1825     fi
1826     }
1827    
1828     # ------------------------------------------------------------------------------
1829     # @internal-function java-pkg_die
1830     #
1831     # Enhanced die for Java packages, which displays some information that may be
1832     # useful for debugging bugs on bugzilla.
1833     # ------------------------------------------------------------------------------
1834     #register_die_hook java-pkg_die
1835     if ! hasq java-pkg_die ${EBUILD_DEATH_HOOKS}; then
1836     EBUILD_DEATH_HOOKS="${EBUILD_DEATH_HOOKS} java-pkg_die"
1837     fi
1838    
1839     java-pkg_die() {
1840     echo "!!! When you file a bug report, please include the following information:" >&2
1841     echo "GENTOO_VM=${GENTOO_VM} CLASSPATH=\"${CLASSPATH}\" JAVA_HOME=\"${JAVA_HOME}\"" >&2
1842     echo "JAVACFLAGS=\"${JAVACFLAGS}\" COMPILER=\"${GENTOO_COMPILER}\"" >&2
1843     echo "and of course, the output of emerge --info" >&2
1844     }
1845    
1846 nichoj 1.7
1847     # TODO document
1848     # List jars in the source directory, ${S}
1849     java-pkg_jar-list() {
1850     if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
1851     einfo "Linked Jars"
1852     find "${S}" -type l -name '*.jar' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
1853     einfo "Jars"
1854     find "${S}" -type f -name '*.jar' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
1855     einfo "Classes"
1856     find "${S}" -type f -name '*.class' -print0 | xargs -0 -r -n 500 ls -ald | sed -e "s,${WORKDIR},\${WORKDIR},"
1857     fi
1858     }
1859    
1860     # TODO document
1861     # Verify that the classes were compiled for the right source / target
1862     java-pkg_verify-classes() {
1863     ebegin "Verifying java class versions"
1864     #$(find ${D} -type f -name '*.jar' -o -name '*.class')
1865 betelgeuse 1.19 class-version-verify.py -t $(java-pkg_get-target) -r ${D}
1866 nichoj 1.7 result=$?
1867     eend ${result}
1868     if [[ ${result} == 0 ]]; then
1869     einfo "All good"
1870     else
1871     ewarn "Possible problem"
1872     die "Bad class files found"
1873     fi
1874     }
1875    
1876    
1877 nichoj 1.1 # ------------------------------------------------------------------------------
1878     # @section-end internal
1879     # ------------------------------------------------------------------------------
1880    
1881     java-pkg_check-phase() {
1882     local phase=${1}
1883     local funcname=${2}
1884 nichoj 1.9 if is-java-strict && [[ ${EBUILD_PHASE} != ${phase} ]]; then
1885 nichoj 1.1 java-pkg_announce-qa-violation \
1886     "${funcname} used outside of src_${phase}"
1887     fi
1888     }
1889    
1890     java-pkg_check-versioned-jar() {
1891     local jar=${1}
1892    
1893     if [[ ${jar} =~ ${PV} ]]; then
1894     java-pkg_announce-qa-violation "installing versioned jar '${jar}'"
1895     fi
1896     }
1897    
1898     java-pkg_check-jikes() {
1899     if hasq jikes ${IUSE}; then
1900     java-pkg_announce-qa-violation "deprecated USE flag 'jikes' in IUSE"
1901     fi
1902     }
1903    
1904     java-pkg_announce-qa-violation() {
1905 nichoj 1.9 if is-java-strict; then
1906 nichoj 1.1 echo "Java QA Notice: $@" >&2
1907     increment-qa-violations
1908     fi
1909     }
1910    
1911     increment-qa-violations() {
1912     let "JAVA_PKG_QA_VIOLATIONS+=1"
1913     export JAVA_PKG_QA_VIOLATIONS
1914     }
1915    
1916 nichoj 1.9 is-java-strict() {
1917 nichoj 1.14 [[ -n ${JAVA_PKG_STRICT} ]]
1918 nichoj 1.9 return $?
1919     }
1920    
1921 nichoj 1.1 # ------------------------------------------------------------------------------
1922     # @eclass-end
1923     # ------------------------------------------------------------------------------

  ViewVC Help
Powered by ViewVC 1.1.20