/[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.41 - (show annotations) (download)
Wed Oct 1 15:43:55 2008 UTC (5 years, 9 months ago) by betelgeuse
Branch: MAIN
Changes since 1.40: +2 -2 lines
Remove conditionals from EXPORT_FUNCTIONS until I figure out why it fails sourcing.

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.40 2008/10/01 15:23:17 betelgeuse 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 JAVA_ANT_E_DEPEND=""
41 # add ant-core into DEPEND, unless disabled
42 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
46 # 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 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 DEPEND=">=dev-java/javatoolkit-0.3.0-r2 ${JAVA_PKG_PORTAGE_DEP} ${JAVA_ANT_E_DEPEND}"
67
68 # ------------------------------------------------------------------------------
69 # @global JAVA_PKG_BSFIX
70 #
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 JAVA_PKG_BSFIX=${JAVA_PKG_BSFIX:-"on"}
77
78 # ------------------------------------------------------------------------------
79 # @global JAVA_PKG_BSFIX_ALL
80 #
81 # If we're fixing build files, should we try to fix all the ones we can find?
82 #
83 # default: yes
84 # ------------------------------------------------------------------------------
85 JAVA_PKG_BSFIX_ALL=${JAVA_PKG_BSFIX_ALL:-"yes"}
86
87 # ------------------------------------------------------------------------------
88 # @global JAVA_PKG_BSFIX_NAME
89 #
90 # Filename of build files to fix/search for
91 #
92 # default: build.xml
93 # ------------------------------------------------------------------------------
94 JAVA_PKG_BSFIX_NAME=${JAVA_PKG_BSFIX_NAME:-"build.xml"}
95
96 # ------------------------------------------------------------------------------
97 # @global JAVA_PKG_BSFIX_TARGETS_TAGS
98 #
99 # Targets to fix the 'source' attribute in
100 #
101 # default: javac xjavac javac.preset
102 # ------------------------------------------------------------------------------
103 JAVA_PKG_BSFIX_TARGET_TAGS=${JAVA_PKG_BSFIX_TARGET_TAGS:-"javac xjavac javac.preset"}
104
105 # ------------------------------------------------------------------------------
106 # @global JAVA_PKG_BSFIX_SOURCE_TAGS
107 #
108 # Targets to fix the 'target' attribute in
109 #
110 # default: javacdoc javac xjavac javac.preset
111 # ------------------------------------------------------------------------------
112 JAVA_PKG_BSFIX_SOURCE_TAGS=${JAVA_PKG_BSFIX_SOURCE_TAGS:-"javadoc javac xjavac javac.preset"}
113
114 # ------------------------------------------------------------------------------
115 # @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 # @global JAVA_ANT_IGNORE_SYSTEM_CLASSES
125 #
126 # Rewrites available tasks to ignore ant classpath.
127 #
128 # default: off
129 # ------------------------------------------------------------------------------
130
131 EXPORT_FUNCTIONS src_configure
132
133 # ------------------------------------------------------------------------------
134 # @eclass-src_configure
135 #
136 # src_configure rewrites the build.xml files
137 # ------------------------------------------------------------------------------
138 java-ant-2_src_configure() {
139 # eant will call us unless called by Portage
140 [[ -e "${T}/java-ant-2_src_configure-run" ]] && return
141
142 [[ "${JAVA_ANT_IGNORE_SYSTEM_CLASSES}" ]] \
143 && java-ant_ignore-system-classes "${S}/build.xml"
144
145 java-ant_bsfix
146 touch "${T}/java-ant-2_src_configure-run"
147 }
148
149 # ------------------------------------------------------------------------------
150 # @private java-ant_bsfix
151 #
152 # Attempts to fix build files. The following variables will affect its behavior
153 # as listed above:
154 # JAVA_PKG_BSFIX
155 # JAVA_PKG_BSFIX_ALL
156 # JAVA_PKG_BSFIX_NAME,
157 # ------------------------------------------------------------------------------
158 java-ant_bsfix() {
159 debug-print-function ${FUNCNAME} $*
160
161 [[ "${JAVA_PKG_BSFIX}" != "on" ]] && return
162 if ! java-pkg_needs-vm; then
163 echo "QA Notice: Package is using java-ant, but doesn't depend on a Java VM"
164 fi
165
166 pushd "${S}" >/dev/null
167
168 local find_args=""
169 [[ "${JAVA_PKG_BSFIX_ALL}" == "yes" ]] || find_args="-maxdepth 1"
170
171 find_args="${find_args} -type f -name ${JAVA_PKG_BSFIX_NAME// / -o -name } "
172
173 # This voodoo is done for paths with spaces
174 local bsfix_these
175 while read line; do
176 [[ -z ${line} ]] && continue
177 bsfix_these="${bsfix_these} '${line}'"
178 done <<-EOF
179 $(find . ${find_args})
180 EOF
181
182 [[ "${bsfix_these// /}" ]] && eval java-ant_bsfix_files ${bsfix_these}
183
184 popd > /dev/null
185 }
186
187 _bsfix_die() {
188 if has_version dev-python/pyxml; then
189 eerror "If the output above contains:"
190 eerror "ImportError:"
191 eerror "/usr/lib/python2.4/site-packages/_xmlplus/parsers/pyexpat.so:"
192 eerror "undefined symbol: PyUnicodeUCS2_DecodeUTF8"
193 eerror "Try re-emerging dev-python/pyxml"
194 die ${1} " Look at the eerror message above"
195 else
196 die ${1}
197 fi
198 }
199
200 # ------------------------------------------------------------------------------
201 # @public java-ant_bsfix_files
202 #
203 # Attempts to fix named build files. The following variables will affect its behavior
204 # as listed above:
205 # JAVA_PKG_BSFIX_SOURCE_TAGS
206 # JAVA_PKG_BSFIX_TARGET_TAGS
207 # JAVA_ANT_REWRITE_CLASSPATH
208 # JAVA_ANT_JAVADOC_INPUT_DIRS: Where we can find java sources for javadoc
209 # input. Can be a space separated list of
210 # directories
211 # JAVA_ANT_BSFIX_EXTRA_ARGS: You can use this to pass extra variables to the
212 # rewriter if you know what you are doing.
213 #
214 # If JAVA_ANT_JAVADOC_INPUT_DIRS is set, we will turn on the adding of a basic
215 # javadoc target to the ant's build.xml with the javadoc xml-rewriter feature.
216 # Then we will set EANT DOC TARGET to the added javadoc target
217 # NOTE: the variable JAVA_ANT_JAVADOC_OUTPUT_DIR points where we will
218 # generate the javadocs. This is a read-only variable, dont change it.
219
220 # When changing this function, make sure that it works with paths with spaces in
221 # them.
222 # ------------------------------------------------------------------------------
223 java-ant_bsfix_files() {
224 debug-print-function ${FUNCNAME} $*
225
226 [[ ${#} = 0 ]] && die "${FUNCNAME} called without arguments"
227
228 local want_source="$(java-pkg_get-source)"
229 local want_target="$(java-pkg_get-target)"
230
231 debug-print "${FUNCNAME}: target: ${want_target} source: ${want_source}"
232
233 if [ -z "${want_source}" -o -z "${want_target}" ]; then
234 eerror "Could not find valid -source/-target values"
235 eerror "Please file a bug about this on bugs.gentoo.org"
236 die "Could not find valid -source/-target values"
237 else
238 local files
239
240 for file in "${@}"; do
241 debug-print "${FUNCNAME}: ${file}"
242
243 if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
244 cp "${file}" "${file}.orig" || die "failed to copy ${file}"
245 fi
246
247 if [[ ! -w "${file}" ]]; then
248 chmod u+w "${file}" || die "chmod u+w ${file} failed"
249 fi
250
251 files="${files} -f '${file}'"
252 done
253
254 # Play nice with paludis
255 if [[ $(type -t quiet_mode) = function ]] && quiet_mode; then
256 local output=">/dev/null"
257 fi
258
259 # for javadoc target and all in one pass, we need the new rewriter.
260 local rewriter3="/usr/share/javatoolkit/xml-rewrite-3.py"
261 if [[ ! -f ${rewriter3} ]]; then
262 rewriter3="/usr/$(get_libdir)/javatoolkit/bin/xml-rewrite-3.py"
263 fi
264
265 local rewriter4="/usr/$(get_libdir)/javatoolkit/bin/build-xml-rewrite"
266
267 if [[ -x ${rewriter4} && ${JAVA_ANT_ENCODING} ]]; then
268 [[ ${JAVA_ANT_REWRITE_CLASSPATH} ]] && local gcp="-g"
269 [[ ${JAVA_ANT_ENCODING} ]] && local enc="-e ${JAVA_ANT_ENCODING}"
270 eval echo "cElementTree rewriter" ${output}
271 debug-print "${rewriter4} extra args: ${gcp} ${enc}"
272 ${rewriter4} ${gcp} ${enc} \
273 -c "${JAVA_PKG_BSFIX_SOURCE_TAGS}" source ${want_source} \
274 -c "${JAVA_PKG_BSFIX_TARGET_TAGS}" target ${want_target} \
275 "${@}" || die "build-xml-rewrite failed"
276 elif [[ ! -f ${rewriter3} ]]; then
277 debug-print "Using second generation rewriter"
278 eval echo "Rewriting source attributes" ${output}
279 eval xml-rewrite-2.py ${files} \
280 -c -e ${JAVA_PKG_BSFIX_SOURCE_TAGS// / -e } \
281 -a source -v ${want_source} ${output} || _bsfix_die "xml-rewrite2 failed: ${file}"
282
283 eval echo "Rewriting target attributes" ${output}
284 eval xml-rewrite-2.py ${files} \
285 -c -e ${JAVA_PKG_BSFIX_TARGET_TAGS// / -e } \
286 -a target -v ${want_target} ${output} || _bsfix_die "xml-rewrite2 failed: ${file}"
287
288 eval echo "Rewriting nowarn attributes" ${output}
289 eval xml-rewrite-2.py ${files} \
290 -c -e ${JAVA_PKG_BSFIX_TARGET_TAGS// / -e } \
291 -a nowarn -v yes ${output} || _bsfix_die "xml-rewrite2 failed: ${file}"
292
293 if [[ ${JAVA_ANT_REWRITE_CLASSPATH} ]]; then
294 eval echo "Adding gentoo.classpath to javac tasks" ${output}
295 eval xml-rewrite-2.py ${files} \
296 -c -e javac -e xjavac -a classpath -v \
297 '\${gentoo.classpath}' \
298 || _bsfix_die "xml-rewrite2 failed"
299 fi
300 else
301 debug-print "Using third generation rewriter"
302 eval echo "Rewriting attributes" ${output}
303 local bsfix_extra_args=""
304 # WARNING KEEP THE ORDER, ESPECIALLY FOR CHANGED ATTRIBUTES!
305 if [[ -n ${JAVA_ANT_REWRITE_CLASSPATH} ]]; then
306 bsfix_extra_args="${bsfix_extra_args} -g -e javac -e xjavac "
307 bsfix_extra_args="${bsfix_extra_args} -a classpath -v '\${gentoo.classpath}'"
308 fi
309 if [[ -n ${JAVA_ANT_JAVADOC_INPUT_DIRS} ]]; then
310 if [[ -n ${JAVA_ANT_JAVADOC_OUTPUT_DIR} ]]; then
311 die "Do not define JAVA_ANT_JAVADOC_OUTPUT_DIR!"
312 fi
313 # Where will our generated javadoc go.
314 readonly JAVA_ANT_JAVADOC_OUTPUT_DIR="${WORKDIR}/gentoo_javadoc"
315 mkdir -p "${JAVA_ANT_JAVADOC_OUTPUT_DIR}" || die
316
317 if hasq doc ${IUSE}; then
318 if use doc; then
319 if [[ -z ${EANT_DOC_TARGET} ]]; then
320 EANT_DOC_TARGET="gentoojavadoc"
321 else
322 die "You can't use javadoc adding and set EANT_DOC_TARGET too."
323 fi
324
325 for dir in ${JAVA_ANT_JAVADOC_INPUT_DIRS};do
326 if [[ ! -d ${dir} ]]; then
327 eerror "This dir: ${dir} doesnt' exists"
328 die "You must specify directories for javadoc input/output dirs."
329 fi
330 done
331 bsfix_extra_args="${bsfix_extra_args} --javadoc --source-directory "
332 # filter third/double spaces
333 JAVA_ANT_JAVADOC_INPUT_DIRS=${JAVA_ANT_JAVADOC_INPUT_DIRS// /}
334 JAVA_ANT_JAVADOC_INPUT_DIRS=${JAVA_ANT_JAVADOC_INPUT_DIRS// /}
335 bsfix_extra_args="${bsfix_extra_args} ${JAVA_ANT_JAVADOC_INPUT_DIRS// / --source-directory }"
336 bsfix_extra_args="${bsfix_extra_args} --output-directory ${JAVA_ANT_JAVADOC_OUTPUT_DIR}"
337 fi
338 else
339 die "You need to have doc in IUSE when using JAVA_ANT_JAVADOC_INPUT_DIRS"
340 fi
341 fi
342
343 [[ -n ${JAVA_ANT_BSFIX_EXTRA_ARGS} ]] \
344 && bsfix_extra_args="${bsfix_extra_args} ${JAVA_ANT_BSFIX_EXTRA_ARGS}"
345
346 eval ${rewriter3} ${files} \
347 -c --source-element ${JAVA_PKG_BSFIX_SOURCE_TAGS// / --source-element } \
348 --source-attribute source --source-value ${want_source} \
349 --target-element ${JAVA_PKG_BSFIX_TARGET_TAGS// / --target-element } \
350 --target-attribute target --target-value ${want_target} \
351 --target-attribute nowarn --target-value yes \
352 ${bsfix_extra_args} \
353 ${output} || _bsfix_die "xml-rewrite2 failed: ${file}"
354 fi
355
356 if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
357 for file in "${@}"; do
358 diff -NurbB "${file}.orig" "${file}"
359 done
360 fi
361 fi
362 return 0 # so that the 1 for diff doesn't get reported
363 }
364
365
366 # ------------------------------------------------------------------------------
367 # @public java-ant_bsfix_one
368 #
369 # Attempts to fix named build file. The following variables will affect its behavior
370 # as listed above:
371 # JAVA_PKG_BSFIX_SOURCE_TAGS
372 # JAVA_PKG_BSFIX_TARGET_TAGS
373 # ------------------------------------------------------------------------------
374 java-ant_bsfix_one() {
375 debug-print-function ${FUNCNAME} $*
376
377 if [ -z "${1}" ]; then
378 eerror "${FUNCNAME} needs one argument"
379 die "${FUNCNAME} needs one argument"
380 fi
381
382 java-ant_bsfix_files "${1}"
383 }
384
385 # ------------------------------------------------------------------------------
386 # @public java-ant_rewrite-classpath
387 #
388 # Adds 'classpath="${gentoo.classpath}"' to specified build file.
389 # Affected by:
390 # JAVA_ANT_CLASSPATH_TAGS
391 # @param $1 - the file to rewrite (defaults to build.xml)
392 # ------------------------------------------------------------------------------
393 java-ant_rewrite-classpath() {
394 debug-print-function ${FUNCNAME} $*
395
396 local file="${1}"
397 [[ -z "${1}" ]] && file=build.xml
398 [[ ${#} -gt 1 ]] && die "${FUNCNAME} currently can only rewrite one file."
399
400 echo "Adding gentoo.classpath to ${file}"
401 debug-print "java-ant_rewrite-classpath: ${file}"
402
403 cp "${file}" "${file}.orig" || die "failed to copy ${file}"
404
405 chmod u+w "${file}"
406
407 java-ant_xml-rewrite -f "${file}" --change \
408 -e ${JAVA_ANT_CLASSPATH_TAGS// / -e } -a classpath -v '${gentoo.classpath}'
409
410 if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
411 diff -NurbB "${file}.orig" "${file}"
412 fi
413 }
414
415 # ------------------------------------------------------------------------------
416 # @public java-ant_ignore-system-classes
417 #
418 # Makes the available task ignore classes in the system classpath
419 # @param $1 - the file to rewrite (defaults to build.xml)
420 # ------------------------------------------------------------------------------
421 java-ant_ignore-system-classes() {
422 debug-print-function ${FUNCNAME} $*
423 local file=${1:-build.xml}
424 echo "Changing ignoresystemclasses to true for available tasks in ${file}"
425 java-ant_xml-rewrite -f "${file}" --change \
426 -e available -a ignoresystemclasses -v "true"
427 }
428
429 # ------------------------------------------------------------------------------
430 # @public java-ant_xml-rewrite
431 # Run the right xml-rewrite binary with the given arguments
432 # ------------------------------------------------------------------------------
433 java-ant_xml-rewrite() {
434 local gen2="/usr/bin/xml-rewrite-2.py"
435 local gen2_1="/usr/$(get_libdir)/javatoolkit/bin/xml-rewrite-2.py"
436 # gen1 is deprecated
437 if [[ -x "${gen2}" ]]; then
438 ${gen2} "${@}" || die "${gen2} failed"
439 elif [[ -x "${gen2_1}" ]]; then
440 ${gen2_1} "${@}" || die "${gen2_1} failed"
441 else
442 eerror "No binary for rewriting found."
443 eerror "Do you have dev-java/javatoolkit installed?"
444 die "xml-rewrite not found"
445 fi
446 }

  ViewVC Help
Powered by ViewVC 1.1.20