/[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.50 - (show annotations) (download)
Sun Oct 17 12:55:00 2010 UTC (3 years, 9 months ago) by betelgeuse
Branch: MAIN
Changes since 1.49: +31 -6 lines
Add java-ant_remote-taskdefs

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 # Changes:
6 # 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 # 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 #
15 # Licensed under the GNU General Public License, v2
16 #
17 # $Header: /var/cvsroot/gentoo-x86/eclass/java-ant-2.eclass,v 1.49 2010/04/29 08:40:29 caster Exp $
18
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 # -----------------------------------------------------------------------------
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 # -----------------------------------------------------------------------------
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
39 # construct ant-speficic DEPEND
40 # add ant-core into DEPEND, unless disabled
41 if [[ -z "${JAVA_ANT_DISABLE_ANT_CORE_DEP}" ]]; then
42 JAVA_ANT_E_DEPEND="${JAVA_ANT_E_DEPEND} >=dev-java/ant-core-1.7.0"
43 fi
44
45 # add ant tasks specified in WANT_ANT_TASKS to DEPEND
46 local ANT_TASKS_DEPEND;
47 ANT_TASKS_DEPEND="$(java-pkg_ant-tasks-depend)"
48 # check that java-pkg_ant-tasks-depend didn't fail
49 if [[ $? != 0 ]]; then
50 eerror "${ANT_TASKS_DEPEND}"
51 die "java-pkg_ant-tasks-depend() failed"
52 fi
53
54 # We need some tools from javatoolkit. We also need portage 2.1 for phase hooks
55 # and ant dependencies constructed above. Python is there for
56 # java-ant_remove-taskdefs
57 JAVA_ANT_E_DEPEND="${JAVA_ANT_E_DEPEND}
58 ${ANT_TASKS_DEPEND}
59 ${JAVA_PKG_PORTAGE_DEP}
60 >=dev-java/javatoolkit-0.3.0-r2
61 >=dev-lang/python-2.4"
62
63 # this eclass must be inherited after java-pkg-2 or java-pkg-opt-2
64 # if it's java-pkg-opt-2, ant dependencies are pulled based on USE flag
65 if hasq java-pkg-opt-2 ${INHERITED}; then
66 JAVA_ANT_E_DEPEND="${JAVA_PKG_OPT_USE}? ( ${JAVA_ANT_E_DEPEND} )"
67 elif ! hasq java-pkg-2 ${INHERITED}; then
68 eerror "java-ant-2 eclass can only be inherited AFTER java-pkg-2 or java-pkg-opt-2"
69 fi
70
71 DEPEND="${JAVA_ANT_E_DEPEND}"
72
73 # ------------------------------------------------------------------------------
74 # @global JAVA_PKG_BSFIX
75 #
76 # Should we attempt to 'fix' ant build files to include the source/target
77 # attributes when calling javac?
78 #
79 # default: on
80 # ------------------------------------------------------------------------------
81 JAVA_PKG_BSFIX=${JAVA_PKG_BSFIX:-"on"}
82
83 # ------------------------------------------------------------------------------
84 # @global JAVA_PKG_BSFIX_ALL
85 #
86 # If we're fixing build files, should we try to fix all the ones we can find?
87 #
88 # default: yes
89 # ------------------------------------------------------------------------------
90 JAVA_PKG_BSFIX_ALL=${JAVA_PKG_BSFIX_ALL:-"yes"}
91
92 # ------------------------------------------------------------------------------
93 # @global JAVA_PKG_BSFIX_NAME
94 #
95 # Filename of build files to fix/search for
96 #
97 # default: build.xml
98 # ------------------------------------------------------------------------------
99 JAVA_PKG_BSFIX_NAME=${JAVA_PKG_BSFIX_NAME:-"build.xml"}
100
101 # ------------------------------------------------------------------------------
102 # @global JAVA_PKG_BSFIX_TARGETS_TAGS
103 #
104 # Targets to fix the 'source' attribute in
105 #
106 # default: javac xjavac javac.preset
107 # ------------------------------------------------------------------------------
108 JAVA_PKG_BSFIX_TARGET_TAGS=${JAVA_PKG_BSFIX_TARGET_TAGS:-"javac xjavac javac.preset"}
109
110 # ------------------------------------------------------------------------------
111 # @global JAVA_PKG_BSFIX_SOURCE_TAGS
112 #
113 # Targets to fix the 'target' attribute in
114 #
115 # default: javacdoc javac xjavac javac.preset
116 # ------------------------------------------------------------------------------
117 JAVA_PKG_BSFIX_SOURCE_TAGS=${JAVA_PKG_BSFIX_SOURCE_TAGS:-"javadoc javac xjavac javac.preset"}
118
119 # ------------------------------------------------------------------------------
120 # @global JAVA_ANT_CLASSPATH_TAGS
121 #
122 # Targets to add the classpath attribute to
123 #
124 # default: javac xjavac
125 # ------------------------------------------------------------------------------
126 JAVA_ANT_CLASSPATH_TAGS="javac xjavac"
127
128 # ------------------------------------------------------------------------------
129 # @global JAVA_ANT_IGNORE_SYSTEM_CLASSES
130 #
131 # Rewrites available tasks to ignore ant classpath.
132 #
133 # default: off
134 # ------------------------------------------------------------------------------
135
136 case "${EAPI:-0}" in
137 0|1) : ;;
138 *) EXPORT_FUNCTIONS src_configure ;;
139 esac
140
141 # ------------------------------------------------------------------------------
142 # @eclass-src_configure
143 #
144 # src_configure rewrites the build.xml files
145 # ------------------------------------------------------------------------------
146 java-ant-2_src_configure() {
147 # if java support is optional, don't perform this when the USE flag is off
148 if hasq java-pkg-opt-2 ${INHERITED}; then
149 use ${JAVA_PKG_OPT_USE} || return
150 fi
151
152 # eant will call us unless called by Portage
153 [[ -e "${T}/java-ant-2_src_configure-run" ]] && return
154
155 [[ "${JAVA_ANT_IGNORE_SYSTEM_CLASSES}" ]] \
156 && java-ant_ignore-system-classes "${S}/build.xml"
157
158 java-ant_bsfix
159 touch "${T}/java-ant-2_src_configure-run"
160 }
161
162 # ------------------------------------------------------------------------------
163 # @private java-ant_bsfix
164 #
165 # Attempts to fix build files. The following variables will affect its behavior
166 # as listed above:
167 # JAVA_PKG_BSFIX
168 # JAVA_PKG_BSFIX_ALL
169 # JAVA_PKG_BSFIX_NAME,
170 # ------------------------------------------------------------------------------
171 java-ant_bsfix() {
172 debug-print-function ${FUNCNAME} $*
173
174 [[ "${JAVA_PKG_BSFIX}" != "on" ]] && return
175 if ! java-pkg_needs-vm; then
176 echo "QA Notice: Package is using java-ant, but doesn't depend on a Java VM"
177 fi
178
179 pushd "${S}" >/dev/null
180
181 local find_args=""
182 [[ "${JAVA_PKG_BSFIX_ALL}" == "yes" ]] || find_args="-maxdepth 1"
183
184 find_args="${find_args} -type f -name ${JAVA_PKG_BSFIX_NAME// / -o -name } "
185
186 # This voodoo is done for paths with spaces
187 local bsfix_these
188 while read line; do
189 [[ -z ${line} ]] && continue
190 bsfix_these="${bsfix_these} '${line}'"
191 done <<-EOF
192 $(find . ${find_args})
193 EOF
194
195 [[ "${bsfix_these// /}" ]] && eval java-ant_bsfix_files ${bsfix_these}
196
197 popd > /dev/null
198 }
199
200 _bsfix_die() {
201 if has_version dev-python/pyxml; then
202 eerror "If the output above contains:"
203 eerror "ImportError:"
204 eerror "/usr/lib/python2.4/site-packages/_xmlplus/parsers/pyexpat.so:"
205 eerror "undefined symbol: PyUnicodeUCS2_DecodeUTF8"
206 eerror "Try re-emerging dev-python/pyxml"
207 die ${1} " Look at the eerror message above"
208 else
209 die ${1}
210 fi
211 }
212
213 # ------------------------------------------------------------------------------
214 # @public java-ant_bsfix_files
215 #
216 # Attempts to fix named build files. The following variables will affect its behavior
217 # as listed above:
218 # JAVA_PKG_BSFIX_SOURCE_TAGS
219 # JAVA_PKG_BSFIX_TARGET_TAGS
220 # JAVA_ANT_REWRITE_CLASSPATH
221 # JAVA_ANT_JAVADOC_INPUT_DIRS: Where we can find java sources for javadoc
222 # input. Can be a space separated list of
223 # directories
224 # JAVA_ANT_BSFIX_EXTRA_ARGS: You can use this to pass extra variables to the
225 # rewriter if you know what you are doing.
226 #
227 # If JAVA_ANT_JAVADOC_INPUT_DIRS is set, we will turn on the adding of a basic
228 # javadoc target to the ant's build.xml with the javadoc xml-rewriter feature.
229 # Then we will set EANT DOC TARGET to the added javadoc target
230 # NOTE: the variable JAVA_ANT_JAVADOC_OUTPUT_DIR points where we will
231 # generate the javadocs. This is a read-only variable, dont change it.
232
233 # When changing this function, make sure that it works with paths with spaces in
234 # them.
235 # ------------------------------------------------------------------------------
236 java-ant_bsfix_files() {
237 debug-print-function ${FUNCNAME} $*
238
239 [[ ${#} = 0 ]] && die "${FUNCNAME} called without arguments"
240
241 local want_source="$(java-pkg_get-source)"
242 local want_target="$(java-pkg_get-target)"
243
244 debug-print "${FUNCNAME}: target: ${want_target} source: ${want_source}"
245
246 if [ -z "${want_source}" -o -z "${want_target}" ]; then
247 eerror "Could not find valid -source/-target values"
248 eerror "Please file a bug about this on bugs.gentoo.org"
249 die "Could not find valid -source/-target values"
250 else
251 local files
252
253 for file in "${@}"; do
254 debug-print "${FUNCNAME}: ${file}"
255
256 if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
257 cp "${file}" "${file}.orig" || die "failed to copy ${file}"
258 fi
259
260 if [[ ! -w "${file}" ]]; then
261 chmod u+w "${file}" || die "chmod u+w ${file} failed"
262 fi
263
264 files="${files} -f '${file}'"
265 done
266
267 # Play nice with paludis
268 if [[ $(type -t quiet_mode) = function ]] && quiet_mode; then
269 local output=">/dev/null"
270 fi
271
272 # for javadoc target and all in one pass, we need the new rewriter.
273 local rewriter3="/usr/share/javatoolkit/xml-rewrite-3.py"
274 if [[ ! -f ${rewriter3} ]]; then
275 rewriter3="/usr/$(get_libdir)/javatoolkit/bin/xml-rewrite-3.py"
276 fi
277
278 local rewriter4="/usr/$(get_libdir)/javatoolkit/bin/build-xml-rewrite"
279
280 if [[ -x ${rewriter4} && ${JAVA_ANT_ENCODING} ]]; then
281 [[ ${JAVA_ANT_REWRITE_CLASSPATH} ]] && local gcp="-g"
282 [[ ${JAVA_ANT_ENCODING} ]] && local enc="-e ${JAVA_ANT_ENCODING}"
283 eval echo "cElementTree rewriter" ${output}
284 debug-print "${rewriter4} extra args: ${gcp} ${enc}"
285 ${rewriter4} ${gcp} ${enc} \
286 -c "${JAVA_PKG_BSFIX_SOURCE_TAGS}" source ${want_source} \
287 -c "${JAVA_PKG_BSFIX_TARGET_TAGS}" target ${want_target} \
288 "${@}" || die "build-xml-rewrite failed"
289 elif [[ ! -f ${rewriter3} ]]; then
290 debug-print "Using second generation rewriter"
291 eval echo "Rewriting source attributes" ${output}
292 eval xml-rewrite-2.py ${files} \
293 -c -e ${JAVA_PKG_BSFIX_SOURCE_TAGS// / -e } \
294 -a source -v ${want_source} ${output} || _bsfix_die "xml-rewrite2 failed: ${file}"
295
296 eval echo "Rewriting target attributes" ${output}
297 eval xml-rewrite-2.py ${files} \
298 -c -e ${JAVA_PKG_BSFIX_TARGET_TAGS// / -e } \
299 -a target -v ${want_target} ${output} || _bsfix_die "xml-rewrite2 failed: ${file}"
300
301 eval echo "Rewriting nowarn attributes" ${output}
302 eval xml-rewrite-2.py ${files} \
303 -c -e ${JAVA_PKG_BSFIX_TARGET_TAGS// / -e } \
304 -a nowarn -v yes ${output} || _bsfix_die "xml-rewrite2 failed: ${file}"
305
306 if [[ ${JAVA_ANT_REWRITE_CLASSPATH} ]]; then
307 eval echo "Adding gentoo.classpath to javac tasks" ${output}
308 eval xml-rewrite-2.py ${files} \
309 -c -e javac -e xjavac -a classpath -v \
310 '\${gentoo.classpath}' \
311 || _bsfix_die "xml-rewrite2 failed"
312 fi
313 else
314 debug-print "Using third generation rewriter"
315 eval echo "Rewriting attributes" ${output}
316 local bsfix_extra_args=""
317 # WARNING KEEP THE ORDER, ESPECIALLY FOR CHANGED ATTRIBUTES!
318 if [[ -n ${JAVA_ANT_REWRITE_CLASSPATH} ]]; then
319 local cp_tags="${JAVA_ANT_CLASSPATH_TAGS// / -e }"
320 bsfix_extra_args="${bsfix_extra_args} -g -e ${cp_tags}"
321 bsfix_extra_args="${bsfix_extra_args} -a classpath -v '\${gentoo.classpath}'"
322 fi
323 if [[ -n ${JAVA_ANT_JAVADOC_INPUT_DIRS} ]]; then
324 if [[ -n ${JAVA_ANT_JAVADOC_OUTPUT_DIR} ]]; then
325 die "Do not define JAVA_ANT_JAVADOC_OUTPUT_DIR!"
326 fi
327 # Where will our generated javadoc go.
328 readonly JAVA_ANT_JAVADOC_OUTPUT_DIR="${WORKDIR}/gentoo_javadoc"
329 mkdir -p "${JAVA_ANT_JAVADOC_OUTPUT_DIR}" || die
330
331 if hasq doc ${IUSE}; then
332 if use doc; then
333 if [[ -z ${EANT_DOC_TARGET} ]]; then
334 EANT_DOC_TARGET="gentoojavadoc"
335 else
336 die "You can't use javadoc adding and set EANT_DOC_TARGET too."
337 fi
338
339 for dir in ${JAVA_ANT_JAVADOC_INPUT_DIRS};do
340 if [[ ! -d ${dir} ]]; then
341 eerror "This dir: ${dir} doesnt' exists"
342 die "You must specify directories for javadoc input/output dirs."
343 fi
344 done
345 bsfix_extra_args="${bsfix_extra_args} --javadoc --source-directory "
346 # filter third/double spaces
347 JAVA_ANT_JAVADOC_INPUT_DIRS=${JAVA_ANT_JAVADOC_INPUT_DIRS// /}
348 JAVA_ANT_JAVADOC_INPUT_DIRS=${JAVA_ANT_JAVADOC_INPUT_DIRS// /}
349 bsfix_extra_args="${bsfix_extra_args} ${JAVA_ANT_JAVADOC_INPUT_DIRS// / --source-directory }"
350 bsfix_extra_args="${bsfix_extra_args} --output-directory ${JAVA_ANT_JAVADOC_OUTPUT_DIR}"
351 fi
352 else
353 die "You need to have doc in IUSE when using JAVA_ANT_JAVADOC_INPUT_DIRS"
354 fi
355 fi
356
357 [[ -n ${JAVA_ANT_BSFIX_EXTRA_ARGS} ]] \
358 && bsfix_extra_args="${bsfix_extra_args} ${JAVA_ANT_BSFIX_EXTRA_ARGS}"
359
360 debug-print "bsfix_extra_args: ${bsfix_extra_args}"
361
362 eval ${rewriter3} ${files} \
363 -c --source-element ${JAVA_PKG_BSFIX_SOURCE_TAGS// / --source-element } \
364 --source-attribute source --source-value ${want_source} \
365 --target-element ${JAVA_PKG_BSFIX_TARGET_TAGS// / --target-element } \
366 --target-attribute target --target-value ${want_target} \
367 --target-attribute nowarn --target-value yes \
368 ${bsfix_extra_args} \
369 ${output} || _bsfix_die "xml-rewrite2 failed: ${file}"
370 fi
371
372 if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
373 for file in "${@}"; do
374 diff -NurbB "${file}.orig" "${file}"
375 done
376 fi
377 fi
378 return 0 # so that the 1 for diff doesn't get reported
379 }
380
381
382 # ------------------------------------------------------------------------------
383 # @public java-ant_bsfix_one
384 #
385 # Attempts to fix named build file. The following variables will affect its behavior
386 # as listed above:
387 # JAVA_PKG_BSFIX_SOURCE_TAGS
388 # JAVA_PKG_BSFIX_TARGET_TAGS
389 # ------------------------------------------------------------------------------
390 java-ant_bsfix_one() {
391 debug-print-function ${FUNCNAME} $*
392
393 if [ -z "${1}" ]; then
394 eerror "${FUNCNAME} needs one argument"
395 die "${FUNCNAME} needs one argument"
396 fi
397
398 java-ant_bsfix_files "${1}"
399 }
400
401 # ------------------------------------------------------------------------------
402 # @public java-ant_rewrite-classpath
403 #
404 # Adds 'classpath="${gentoo.classpath}"' to specified build file.
405 # Affected by:
406 # JAVA_ANT_CLASSPATH_TAGS
407 # @param $1 - the file to rewrite (defaults to build.xml)
408 # ------------------------------------------------------------------------------
409 java-ant_rewrite-classpath() {
410 debug-print-function ${FUNCNAME} $*
411
412 local file="${1}"
413 [[ -z "${1}" ]] && file=build.xml
414 [[ ${#} -gt 1 ]] && die "${FUNCNAME} currently can only rewrite one file."
415
416 echo "Adding gentoo.classpath to ${file}"
417 debug-print "java-ant_rewrite-classpath: ${file}"
418
419 cp "${file}" "${file}.orig" || die "failed to copy ${file}"
420
421 chmod u+w "${file}"
422
423 java-ant_xml-rewrite -f "${file}" --change \
424 -e ${JAVA_ANT_CLASSPATH_TAGS// / -e } -a classpath -v '${gentoo.classpath}'
425
426 if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
427 diff -NurbB "${file}.orig" "${file}"
428 fi
429 }
430
431 # ------------------------------------------------------------------------------
432 # @public java-ant_remove-taskdefs
433 #
434 # Removes taskdef elements from the file
435 # @param $1 - the file to rewrite (defaults to build.xml)
436 # ------------------------------------------------------------------------------
437 java-ant_remove-taskdefs() {
438 debug-print-function ${FUNCNAME} $*
439 local file=${1:-build.xml}
440 echo "Removing taskdefs from ${file}"
441 python <<EOF
442 import sys
443 from xml.dom.minidom import parse
444 dom = parse("${file}")
445 for elem in dom.getElementsByTagName('taskdef'):
446 elem.parentNode.removeChild(elem)
447 elem.unlink()
448 f = open("${file}", "w")
449 dom.writexml(f)
450 f.close()
451 EOF
452 [[ $? != 0 ]] && die "Removing taskdefs failed"
453 }
454
455 # ------------------------------------------------------------------------------
456 # @public java-ant_ignore-system-classes
457 #
458 # Makes the available task ignore classes in the system classpath
459 # @param $1 - the file to rewrite (defaults to build.xml)
460 # ------------------------------------------------------------------------------
461 java-ant_ignore-system-classes() {
462 debug-print-function ${FUNCNAME} $*
463 local file=${1:-build.xml}
464 echo "Changing ignoresystemclasses to true for available tasks in ${file}"
465 java-ant_xml-rewrite -f "${file}" --change \
466 -e available -a ignoresystemclasses -v "true"
467 }
468
469 # ------------------------------------------------------------------------------
470 # @public java-ant_xml-rewrite
471 # Run the right xml-rewrite binary with the given arguments
472 # ------------------------------------------------------------------------------
473 java-ant_xml-rewrite() {
474 local gen2="/usr/bin/xml-rewrite-2.py"
475 local gen2_1="/usr/$(get_libdir)/javatoolkit/bin/xml-rewrite-2.py"
476 # gen1 is deprecated
477 if [[ -x "${gen2}" ]]; then
478 ${gen2} "${@}" || die "${gen2} failed"
479 elif [[ -x "${gen2_1}" ]]; then
480 ${gen2_1} "${@}" || die "${gen2_1} failed"
481 else
482 eerror "No binary for rewriting found."
483 eerror "Do you have dev-java/javatoolkit installed?"
484 die "xml-rewrite not found"
485 fi
486 }
487
488 # ------------------------------------------------------------------------------
489 # @public java-ant_rewrite-bootclasspath
490 #
491 # Adds bootclasspath to javac-like tasks in build.xml filled with jars of a
492 # bootclasspath package of given version.
493 #
494 # Affected by:
495 # JAVA_PKG_BSFIX_TARGET_TAGS - the tags of javac tasks
496 #
497 # @param $1 - the version of bootclasspath (e.g. 1.5), 'auto' for bootclasspath
498 # of the current JDK
499 # @param $2 - path to desired build.xml file, defaults to 'build.xml'
500 # @param $3 - (optional) what to prepend the bootclasspath with (to override)
501 # @param $4 - (optional) what to append to the bootclasspath
502 # ------------------------------------------------------------------------------
503
504 java-ant_rewrite-bootclasspath() {
505 local version="${1}"
506 local file="${2-build.xml}"
507 local extra_before="${3}"
508 local extra_after="${4}"
509
510 local bcp="$(java-pkg_get-bootclasspath "${version}")"
511
512 if [[ -n "${extra_before}" ]]; then
513 bcp="${extra_before}:${bcp}"
514 fi
515 if [[ -n "${extra_after}" ]]; then
516 bcp="${bcp}:${extra_after}"
517 fi
518
519 java-ant_xml-rewrite -f "${file}" -c -e ${JAVA_PKG_BSFIX_TARGET_TAGS// / -e } \
520 -a bootclasspath -v "${bcp}"
521 }

  ViewVC Help
Powered by ViewVC 1.1.20