/[gentoo-x86]/eclass/java-ant-2.eclass
Gentoo

Contents of /eclass/java-ant-2.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.31 - (hide annotations) (download)
Tue Apr 15 05:23:24 2008 UTC (6 years ago) by ali_bush
Branch: MAIN
Changes since 1.30: +20 -12 lines
Updating java-ant-2.eclass to support relocation of javatoolkit

1 nichoj 1.1 # eclass for ant based Java packages
2     #
3     # Copyright (c) 2004-2005, Thomas Matthijs <axxo@gentoo.org>
4     # Copyright (c) 2004-2005, Gentoo Foundation
5 betelgeuse 1.10 # Changes:
6 betelgeuse 1.22 # May 2007:
7     # Made bsfix make one pass for all things and add some glocal targets for
8     # setting up the whole thing. Contributed by kiorky
9     # (kiorky@cryptelium.net).
10 betelgeuse 1.10 # December 2006:
11     # I pretty much rewrote the logic of the bsfix functions
12     # and xml-rewrite.py because they were so slow
13     # Petteri R├Ąty (betelgeuse@gentoo.org)
14 nichoj 1.1 #
15     # Licensed under the GNU General Public License, v2
16     #
17 ali_bush 1.31 # $Header: /var/cvsroot/gentoo-x86/eclass/java-ant-2.eclass,v 1.30 2008/03/05 19:30:29 betelgeuse Exp $
18 nichoj 1.1
19     inherit java-utils-2
20    
21     # This eclass provides functionality for Java packages which use
22     # ant to build. In particular, it will attempt to fix build.xml files, so that
23     # they use the appropriate 'target' and 'source' attributes.
24    
25 caster 1.14 # -----------------------------------------------------------------------------
26     # @variable-preinherit WANT_ANT_TASKS
27     # @variable-default ""
28     #
29     # Please see the description in java-utils-2.eclass.
30     #WANT_ANT_TASKS
31    
32 caster 1.17 # -----------------------------------------------------------------------------
33     # @variable-preinherit JAVA_ANT_DISABLE_ANT_CORE_DEP
34     # @variable-default unset for java-pkg-2, true for java-pkg-opt-2
35     #
36     # Setting this variable non-empty before inheriting java-ant-2 disables adding
37     # dev-java/ant-core into DEPEND.
38 betelgeuse 1.15
39 caster 1.17 # construct ant-speficic DEPEND
40     JAVA_ANT_E_DEPEND=""
41 caster 1.25 # add ant-core into DEPEND, unless disabled
42 caster 1.17 if [[ -z "${JAVA_ANT_DISABLE_ANT_CORE_DEP}" ]]; then
43     JAVA_ANT_E_DEPEND="${JAVA_ANT_E_DEPEND} >=dev-java/ant-core-1.7.0"
44     fi
45 betelgeuse 1.15
46 caster 1.14 # add ant tasks specified in WANT_ANT_TASKS to DEPEND
47     local ANT_TASKS_DEPEND;
48     ANT_TASKS_DEPEND="$(java-pkg_ant-tasks-depend)"
49     # check that java-pkg_ant-tasks-depend didn't fail
50     if [[ $? != 0 ]]; then
51     eerror "${ANT_TASKS_DEPEND}"
52     die "java-pkg_ant-tasks-depend() failed"
53     fi
54 caster 1.17 JAVA_ANT_E_DEPEND="${JAVA_ANT_E_DEPEND} ${ANT_TASKS_DEPEND}"
55    
56     # this eclass must be inherited after java-pkg-2 or java-pkg-opt-2
57     # if it's java-pkg-opt-2, ant dependencies are pulled based on USE flag
58     if hasq java-pkg-opt-2 ${INHERITED}; then
59     JAVA_ANT_E_DEPEND="${JAVA_PKG_OPT_USE}? ( ${JAVA_ANT_E_DEPEND} )"
60     elif ! hasq java-pkg-2 ${INHERITED}; then
61     eerror "java-ant-2 eclass can only be inherited AFTER java-pkg-2 or java-pkg-opt-2"
62     fi
63    
64     # We need some tools from javatoolkit. We also need portage 2.1 for phase hooks
65     # and ant dependencies constructed above
66 caster 1.20 DEPEND=">=dev-java/javatoolkit-0.2.0-r1 ${JAVA_PKG_PORTAGE_DEP} ${JAVA_ANT_E_DEPEND}"
67 nichoj 1.1
68     # ------------------------------------------------------------------------------
69 nichoj 1.7 # @global JAVA_PKG_BSFIX
70 nichoj 1.1 #
71     # Should we attempt to 'fix' ant build files to include the source/target
72     # attributes when calling javac?
73     #
74     # default: on
75     # ------------------------------------------------------------------------------
76 nichoj 1.7 JAVA_PKG_BSFIX=${JAVA_PKG_BSFIX:-"on"}
77 nichoj 1.1
78     # ------------------------------------------------------------------------------
79 nichoj 1.7 # @global JAVA_PKG_BSFIX_ALL
80 nichoj 1.1 #
81     # If we're fixing build files, should we try to fix all the ones we can find?
82     #
83     # default: yes
84     # ------------------------------------------------------------------------------
85 nichoj 1.7 JAVA_PKG_BSFIX_ALL=${JAVA_PKG_BSFIX_ALL:-"yes"}
86 nichoj 1.1
87     # ------------------------------------------------------------------------------
88 nichoj 1.5 # @global JAVA_PKG_BSFIX_NAME
89 nichoj 1.1 #
90     # Filename of build files to fix/search for
91     #
92     # default: build.xml
93     # ------------------------------------------------------------------------------
94 nichoj 1.7 JAVA_PKG_BSFIX_NAME=${JAVA_PKG_BSFIX_NAME:-"build.xml"}
95 nichoj 1.1
96     # ------------------------------------------------------------------------------
97 nichoj 1.7 # @global JAVA_PKG_BSFIX_TARGETS_TAGS
98 nichoj 1.1 #
99     # Targets to fix the 'source' attribute in
100     #
101     # default: javac xjavac javac.preset
102     # ------------------------------------------------------------------------------
103 nichoj 1.7 JAVA_PKG_BSFIX_TARGET_TAGS=${JAVA_PKG_BSFIX_TARGET_TAGS:-"javac xjavac javac.preset"}
104 nichoj 1.1
105     # ------------------------------------------------------------------------------
106 nichoj 1.7 # @global JAVA_PKG_BSFIX_SOURCE_TAGS
107 nichoj 1.1 #
108     # Targets to fix the 'target' attribute in
109     #
110     # default: javacdoc javac xjavac javac.preset
111     # ------------------------------------------------------------------------------
112 nichoj 1.7 JAVA_PKG_BSFIX_SOURCE_TAGS=${JAVA_PKG_BSFIX_SOURCE_TAGS:-"javadoc javac xjavac javac.preset"}
113 nichoj 1.1
114     # ------------------------------------------------------------------------------
115 betelgeuse 1.30 # @global JAVA_ANT_CLASSPATH_TAGS
116     #
117     # Targets to add the classpath attribute to
118     #
119     # default: javac xjavac
120     # ------------------------------------------------------------------------------
121     JAVA_ANT_CLASSPATH_TAGS="javac xjavac"
122    
123     # ------------------------------------------------------------------------------
124 betelgeuse 1.23 # @global JAVA_ANT_IGNORE_SYSTEM_CLASSES
125 nichoj 1.1 #
126 betelgeuse 1.23 # Rewrites available tasks to ignore ant classpath.
127 nichoj 1.1 #
128 betelgeuse 1.23 # default: off
129 nichoj 1.1 # ------------------------------------------------------------------------------
130    
131     # ------------------------------------------------------------------------------
132     # @private java-ant_bsfix
133     #
134     # Attempts to fix build files. The following variables will affect its behavior
135     # as listed above:
136     # JAVA_PKG_BSFIX
137     # JAVA_PKG_BSFIX_ALL
138     # JAVA_PKG_BSFIX_NAME,
139     # ------------------------------------------------------------------------------
140     java-ant_bsfix() {
141     debug-print-function ${FUNCNAME} $*
142    
143 nelchael 1.4 [[ "${JAVA_PKG_BSFIX}" != "on" ]] && return
144     if ! java-pkg_needs-vm; then
145 nichoj 1.1 echo "QA Notice: Package is using java-ant, but doesn't depend on a Java VM"
146     fi
147    
148 betelgeuse 1.10 pushd "${S}" >/dev/null
149 nelchael 1.4
150 nichoj 1.7 local find_args=""
151     [[ "${JAVA_PKG_BSFIX_ALL}" == "yes" ]] || find_args="-maxdepth 1"
152 swegener 1.8
153 nichoj 1.7 find_args="${find_args} -type f -name ${JAVA_PKG_BSFIX_NAME// / -o -name } "
154 nichoj 1.1
155 betelgeuse 1.10 # This voodoo is done for paths with spaces
156     local bsfix_these
157 nichoj 1.1 while read line; do
158     [[ -z ${line} ]] && continue
159 betelgeuse 1.10 bsfix_these="${bsfix_these} '${line}'"
160 swegener 1.8 done <<-EOF
161 flameeyes 1.3 $(find . ${find_args})
162 nichoj 1.1 EOF
163    
164 betelgeuse 1.10 [[ "${bsfix_these// /}" ]] && eval java-ant_bsfix_files ${bsfix_these}
165    
166     popd > /dev/null
167 nelchael 1.4 }
168    
169 betelgeuse 1.11 _bsfix_die() {
170     if has_version dev-python/pyxml; then
171     eerror "If the output above contains:"
172     eerror "ImportError:"
173     eerror "/usr/lib/python2.4/site-packages/_xmlplus/parsers/pyexpat.so:"
174     eerror "undefined symbol: PyUnicodeUCS2_DecodeUTF8"
175     eerror "Try re-emerging dev-python/pyxml"
176     die ${1} " Look at the eerror message above"
177     else
178     die ${1}
179     fi
180     }
181    
182 nelchael 1.4 # ------------------------------------------------------------------------------
183 betelgeuse 1.10 # @public java-ant_bsfix_files
184 nelchael 1.4 #
185 betelgeuse 1.10 # Attempts to fix named build files. The following variables will affect its behavior
186 nelchael 1.4 # as listed above:
187     # JAVA_PKG_BSFIX_SOURCE_TAGS
188     # JAVA_PKG_BSFIX_TARGET_TAGS
189 betelgeuse 1.22 # JAVA_ANT_REWRITE_CLASSPATH
190     # JAVA_ANT_JAVADOC_INPUT_DIRS: Where we can find java sources for javadoc
191     # input. Can be a space separated list of
192     # directories
193     # JAVA_ANT_BSFIX_EXTRA_ARGS: You can use this to pass extra variables to the
194     # rewriter if you know what you are doing.
195     #
196     # If JAVA_ANT_JAVADOC_INPUT_DIRS is set, we will turn on the adding of a basic
197     # javadoc target to the ant's build.xml with the javadoc xml-rewriter feature.
198     # Then we will set EANT DOC TARGET to the added javadoc target
199     # NOTE: the variable JAVA_ANT_JAVADOC_OUTPUT_DIR points where we will
200     # generate the javadocs. This is a read-only variable, dont change it.
201    
202 betelgeuse 1.10 # When changing this function, make sure that it works with paths with spaces in
203     # them.
204 nelchael 1.4 # ------------------------------------------------------------------------------
205 betelgeuse 1.10 java-ant_bsfix_files() {
206 nelchael 1.4 debug-print-function ${FUNCNAME} $*
207    
208 betelgeuse 1.10 [[ ${#} = 0 ]] && die "${FUNCNAME} called without arguments"
209 nelchael 1.4
210 nichoj 1.1 local want_source="$(java-pkg_get-source)"
211     local want_target="$(java-pkg_get-target)"
212    
213 betelgeuse 1.10 debug-print "${FUNCNAME}: target: ${want_target} source: ${want_source}"
214 nichoj 1.1
215     if [ -z "${want_source}" -o -z "${want_target}" ]; then
216     eerror "Could not find valid -source/-target values"
217     eerror "Please file a bug about this on bugs.gentoo.org"
218     die "Could not find valid -source/-target values"
219     else
220 betelgeuse 1.10 local files
221 nelchael 1.4
222 betelgeuse 1.10 for file in "${@}"; do
223     debug-print "${FUNCNAME}: ${file}"
224 nelchael 1.4
225 betelgeuse 1.10 if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
226     cp "${file}" "${file}.orig" || die "failed to copy ${file}"
227     fi
228    
229     if [[ ! -w "${file}" ]]; then
230     chmod u+w "${file}" || die "chmod u+w ${file} failed"
231     fi
232    
233     files="${files} -f '${file}'"
234     done
235    
236 betelgeuse 1.28 # Play nice with paludis
237     if [[ $(type -t quiet_mode) = function ]] && quiet_mode; then
238     local output=">/dev/null"
239     fi
240 betelgeuse 1.22
241 betelgeuse 1.28 # for javadoc target and all in one pass, we need the new rewriter.
242     local rewriter3="/usr/share/javatoolkit/xml-rewrite-3.py"
243 ali_bush 1.31 # xml-rewrite will be moving.
244     if [[ ! -f ${rewriter3} ]]; then
245     rewriter3="/usr/$(get_libdir)/javatoolkit/bin/xml-rewrite-3.py"
246     fi
247    
248 betelgeuse 1.28 if [[ ! -f ${rewriter3} ]]; then
249     debug-print "Using second generation rewriter"
250     eval echo "Rewriting source attributes" ${output}
251 ali_bush 1.31 java-ant_xml-rewrite ${files} \
252 betelgeuse 1.28 -c -e ${JAVA_PKG_BSFIX_SOURCE_TAGS// / -e } \
253 ali_bush 1.31 -a source -v ${want_source} ${output}
254 betelgeuse 1.28
255     eval echo "Rewriting target attributes" ${output}
256 ali_bush 1.31 java-ant_xml-rewrite ${files} \
257 betelgeuse 1.28 -c -e ${JAVA_PKG_BSFIX_TARGET_TAGS// / -e } \
258 ali_bush 1.31 -a target -v ${want_target} ${output}
259 betelgeuse 1.28
260     eval echo "Rewriting nowarn attributes" ${output}
261 ali_bush 1.31 java-ant_xml-rewrite ${files} \
262 betelgeuse 1.28 -c -e ${JAVA_PKG_BSFIX_TARGET_TAGS// / -e } \
263 ali_bush 1.31 -a nowarn -v yes ${output}
264 betelgeuse 1.22
265 betelgeuse 1.28 if [[ ${JAVA_ANT_REWRITE_CLASSPATH} ]]; then
266     eval echo "Adding gentoo.classpath to javac tasks" ${output}
267 ali_bush 1.31 java-ant_xml-rewrite ${files} \
268 betelgeuse 1.28 -c -e javac -e xjavac -a classpath -v \
269 ali_bush 1.31 '\${gentoo.classpath}'
270 betelgeuse 1.28 fi
271     else
272     debug-print "Using third generation rewriter"
273     eval echo "Rewriting attributes" ${output}
274     local bsfix_extra_args=""
275     # WARNING KEEP THE ORDER, ESPECIALLY FOR CHANGED ATTRIBUTES!
276     if [[ -n ${JAVA_ANT_REWRITE_CLASSPATH} ]]; then
277     bsfix_extra_args="${bsfix_extra_args} -g -e javac -e xjavac "
278     bsfix_extra_args="${bsfix_extra_args} -a classpath -v '\${gentoo.classpath}'"
279     fi
280     if [[ -n ${JAVA_ANT_JAVADOC_INPUT_DIRS} ]]; then
281     if [[ -n ${JAVA_ANT_JAVADOC_OUTPUT_DIR} ]]; then
282     die "Do not define JAVA_ANT_JAVADOC_OUTPUT_DIR!"
283     fi
284     # Where will our generated javadoc go.
285 betelgeuse 1.29 readonly JAVA_ANT_JAVADOC_OUTPUT_DIR="${WORKDIR}/gentoo_javadoc"
286 betelgeuse 1.28 mkdir -p "${JAVA_ANT_JAVADOC_OUTPUT_DIR}" || die
287    
288     if hasq doc ${IUSE}; then
289     if use doc; then
290     if [[ -z ${EANT_DOC_TARGET} ]]; then
291     EANT_DOC_TARGET="gentoojavadoc"
292     else
293     die "You can't use javadoc adding and set EANT_DOC_TARGET too."
294     fi
295 betelgeuse 1.22
296 betelgeuse 1.28 for dir in ${JAVA_ANT_JAVADOC_INPUT_DIRS};do
297     if [[ ! -d ${dir} ]]; then
298     eerror "This dir: ${dir} doesnt' exists"
299     die "You must specify directories for javadoc input/output dirs."
300 betelgeuse 1.22 fi
301 betelgeuse 1.28 done
302     bsfix_extra_args="${bsfix_extra_args} --javadoc --source-directory "
303     # filter third/double spaces
304     JAVA_ANT_JAVADOC_INPUT_DIRS=${JAVA_ANT_JAVADOC_INPUT_DIRS// /}
305     JAVA_ANT_JAVADOC_INPUT_DIRS=${JAVA_ANT_JAVADOC_INPUT_DIRS// /}
306     bsfix_extra_args="${bsfix_extra_args} ${JAVA_ANT_JAVADOC_INPUT_DIRS// / --source-directory }"
307     bsfix_extra_args="${bsfix_extra_args} --output-directory ${JAVA_ANT_JAVADOC_OUTPUT_DIR}"
308 betelgeuse 1.22 fi
309 betelgeuse 1.28 else
310     die "You need to have doc in IUSE when using JAVA_ANT_JAVADOC_INPUT_DIRS"
311 betelgeuse 1.22 fi
312 betelgeuse 1.28 fi
313 betelgeuse 1.22
314 betelgeuse 1.28 [[ -n ${JAVA_ANT_BSFIX_EXTRA_ARGS} ]] \
315     && bsfix_extra_args="${bsfix_extra_args} ${JAVA_ANT_BSFIX_EXTRA_ARGS}"
316 betelgeuse 1.22
317 betelgeuse 1.28 eval ${rewriter3} ${files} \
318     -c --source-element ${JAVA_PKG_BSFIX_SOURCE_TAGS// / --source-element } \
319     --source-attribute source --source-value ${want_source} \
320     --target-element ${JAVA_PKG_BSFIX_TARGET_TAGS// / --target-element } \
321     --target-attribute target --target-value ${want_target} \
322     --target-attribute nowarn --target-value yes \
323     ${bsfix_extra_args} \
324     ${output} || _bsfix_die "xml-rewrite2 failed: ${file}"
325 betelgeuse 1.10 fi
326 nelchael 1.4
327     if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
328 betelgeuse 1.10 for file in "${@}"; do
329     diff -NurbB "${file}.orig" "${file}"
330     done
331 nelchael 1.4 fi
332 nichoj 1.1 fi
333 betelgeuse 1.24 return 0 # so that the 1 for diff doesn't get reported
334 nichoj 1.1 }
335 nelchael 1.6
336 betelgeuse 1.10
337     # ------------------------------------------------------------------------------
338     # @public java-ant_bsfix_one
339     #
340     # Attempts to fix named build file. The following variables will affect its behavior
341     # as listed above:
342     # JAVA_PKG_BSFIX_SOURCE_TAGS
343     # JAVA_PKG_BSFIX_TARGET_TAGS
344     # ------------------------------------------------------------------------------
345     java-ant_bsfix_one() {
346     debug-print-function ${FUNCNAME} $*
347    
348     if [ -z "${1}" ]; then
349     eerror "${FUNCNAME} needs one argument"
350     die "${FUNCNAME} needs one argument"
351     fi
352    
353     java-ant_bsfix_files "${1}"
354     }
355    
356 nelchael 1.6 # ------------------------------------------------------------------------------
357     # @public java-ant_rewrite-classpath
358     #
359     # Adds 'classpath="${gentoo.classpath}"' to specified build file.
360 betelgeuse 1.30 # Affected by:
361     # JAVA_ANT_CLASSPATH_TAGS
362 betelgeuse 1.12 # @param $1 - the file to rewrite (defaults to build.xml)
363 nelchael 1.6 # ------------------------------------------------------------------------------
364     java-ant_rewrite-classpath() {
365     debug-print-function ${FUNCNAME} $*
366    
367 betelgeuse 1.12 local file="${1}"
368     [[ -z "${1}" ]] && file=build.xml
369 betelgeuse 1.24 [[ ${#} -gt 1 ]] && die "${FUNCNAME} currently can only rewrite one file."
370 nelchael 1.6
371     echo "Adding gentoo.classpath to ${file}"
372     debug-print "java-ant_rewrite-classpath: ${file}"
373    
374     cp "${file}" "${file}.orig" || die "failed to copy ${file}"
375    
376     chmod u+w "${file}"
377    
378 betelgeuse 1.30 java-ant_xml-rewrite -f "${file}" --change \
379     -e ${JAVA_ANT_CLASSPATH_TAGS// / -e } -a classpath -v '${gentoo.classpath}'
380 nelchael 1.6
381     if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
382     diff -NurbB "${file}.orig" "${file}"
383     fi
384     }
385 betelgeuse 1.12
386     # ------------------------------------------------------------------------------
387     # @public java-ant_ignore-system-classes
388     #
389     # Makes the available task ignore classes in the system classpath
390     # @param $1 - the file to rewrite (defaults to build.xml)
391     # ------------------------------------------------------------------------------
392     java-ant_ignore-system-classes() {
393     debug-print-function ${FUNCNAME} $*
394     local file="${1}"
395     [[ -z "${1}" ]] && file=build.xml
396     echo "Changing ignoresystemclasses to true for available tasks"
397     java-ant_xml-rewrite -f "${file}" --change \
398     -e available -a ignoresystemclasses -v "true"
399     }
400    
401     # ------------------------------------------------------------------------------
402     # @public java-ant_xml-rewrite
403     # Run the right xml-rewrite binary with the given arguments
404     # ------------------------------------------------------------------------------
405     java-ant_xml-rewrite() {
406 ali_bush 1.31 # gen1 is deprecated
407 betelgeuse 1.29 local gen2="/usr/bin/xml-rewrite-2.py"
408 ali_bush 1.31 #gen2 xml-rewrite will be moving.
409     if [[ ! -x "${gen2}" ]]; then
410     gen2="/usr/$(get_libdir)/javatoolkit/bin/xml-rewrite-2.py"
411     fi
412 betelgeuse 1.12 if [[ -x "${gen2}" ]]; then
413 ali_bush 1.31 ${gen2} "${@}" || _bsfix_die "xml-rewrite2 failed : ${@}"
414 betelgeuse 1.12 else
415     eerror "No binary for rewriting found."
416     eerror "Do you have dev-java/javatoolkit installed?"
417     die "xml-rewrite not found"
418     fi
419     }

  ViewVC Help
Powered by ViewVC 1.1.20