path: root/eclass/java-ant-2.eclass

# eclass for ant based Java packages
#
# Copyright (c) 2004-2005, Thomas Matthijs <axxo@gentoo.org>
# Copyright (c) 2004-2005, Gentoo Foundation
# Changes:
#   May 2007:
#     Made bsfix make one pass for all things and add some glocal targets for
#     setting up the whole thing. Contributed by  kiorky
#     (kiorky@cryptelium.net).
#   December 2006:
#     I pretty much rewrote the logic of the bsfix functions
#     and xml-rewrite.py because they were so slow
#     Petteri Räty (betelgeuse@gentoo.org)
#
# Licensed under the GNU General Public License, v2
#
# $Header: /var/cvsroot/gentoo-x86/eclass/java-ant-2.eclass,v 1.24 2007/12/18 00:23:06 betelgeuse Exp $

inherit java-utils-2

# This eclass provides functionality for Java packages which use
# ant to build. In particular, it will attempt to fix build.xml files, so that
# they use the appropriate 'target' and 'source' attributes.

# -----------------------------------------------------------------------------
# @variable-preinherit WANT_ANT_TASKS
# @variable-default ""
#
# Please see the description in java-utils-2.eclass.
#WANT_ANT_TASKS

# -----------------------------------------------------------------------------
# @variable-preinherit WANT_SPLIT_ANT
# @variable-default ""
#
# If set, ant-core dependency specifies version with startup script that
# honours ANT_TASKS variable, i.e. >=1.7.0. Using WANT_ANT_TASKS implies
# split-ant already, so you need this only if you manually depend on some
# external package providing ant tasks and want to use it via ANT_TASKS.
[[ -n "${WANT_ANT_TASKS}" ]] && WANT_SPLIT_ANT="true"

# -----------------------------------------------------------------------------
# @variable-preinherit JAVA_ANT_DISABLE_ANT_CORE_DEP
# @variable-default unset for java-pkg-2, true for java-pkg-opt-2
#
# Setting this variable non-empty before inheriting java-ant-2 disables adding
# dev-java/ant-core into DEPEND.

# construct ant-speficic DEPEND
JAVA_ANT_E_DEPEND=""
# add ant-core into DEPEND, unless disabled; respect WANT_SPLIT_ANT
if [[ -z "${JAVA_ANT_DISABLE_ANT_CORE_DEP}" ]]; then
	if [[ -n "${WANT_SPLIT_ANT}" ]]; then
		JAVA_ANT_E_DEPEND="${JAVA_ANT_E_DEPEND} >=dev-java/ant-core-1.7.0"
	else
		JAVA_ANT_E_DEPEND="${JAVA_ANT_E_DEPEND} dev-java/ant-core"
	fi
fi

# add ant tasks specified in WANT_ANT_TASKS to DEPEND
local ANT_TASKS_DEPEND;
ANT_TASKS_DEPEND="$(java-pkg_ant-tasks-depend)"
# check that java-pkg_ant-tasks-depend didn't fail
if [[ $? != 0 ]]; then
	eerror "${ANT_TASKS_DEPEND}"
	die "java-pkg_ant-tasks-depend() failed"
fi
JAVA_ANT_E_DEPEND="${JAVA_ANT_E_DEPEND} ${ANT_TASKS_DEPEND}"

# this eclass must be inherited after java-pkg-2 or java-pkg-opt-2
# if it's java-pkg-opt-2, ant dependencies are pulled based on USE flag
if hasq java-pkg-opt-2 ${INHERITED}; then
	JAVA_ANT_E_DEPEND="${JAVA_PKG_OPT_USE}? ( ${JAVA_ANT_E_DEPEND} )"
elif ! hasq java-pkg-2 ${INHERITED}; then
	eerror "java-ant-2 eclass can only be inherited AFTER java-pkg-2 or java-pkg-opt-2"
fi

# We need some tools from javatoolkit. We also need portage 2.1 for phase hooks
# and ant dependencies constructed above
DEPEND=">=dev-java/javatoolkit-0.2.0-r1 ${JAVA_PKG_PORTAGE_DEP} ${JAVA_ANT_E_DEPEND}"

# ------------------------------------------------------------------------------
# @global JAVA_PKG_BSFIX
#
# Should we attempt to 'fix' ant build files to include the source/target
# attributes when calling javac?
#
# default: on
# ------------------------------------------------------------------------------
JAVA_PKG_BSFIX=${JAVA_PKG_BSFIX:-"on"}

# ------------------------------------------------------------------------------
# @global JAVA_PKG_BSFIX_ALL
#
# If we're fixing build files, should we try to fix all the ones we can find?
#
# default: yes
# ------------------------------------------------------------------------------
JAVA_PKG_BSFIX_ALL=${JAVA_PKG_BSFIX_ALL:-"yes"}

# ------------------------------------------------------------------------------
# @global JAVA_PKG_BSFIX_NAME
#
# Filename of build files to fix/search for
#
# default: build.xml
# ------------------------------------------------------------------------------
JAVA_PKG_BSFIX_NAME=${JAVA_PKG_BSFIX_NAME:-"build.xml"}

# ------------------------------------------------------------------------------
# @global JAVA_PKG_BSFIX_TARGETS_TAGS
#
# Targets to fix the 'source' attribute in
#
# default: javac xjavac javac.preset
# ------------------------------------------------------------------------------
JAVA_PKG_BSFIX_TARGET_TAGS=${JAVA_PKG_BSFIX_TARGET_TAGS:-"javac xjavac javac.preset"}

# ------------------------------------------------------------------------------
# @global JAVA_PKG_BSFIX_SOURCE_TAGS
#
# Targets to fix the 'target' attribute in
#
# default: javacdoc javac xjavac javac.preset
# ------------------------------------------------------------------------------
JAVA_PKG_BSFIX_SOURCE_TAGS=${JAVA_PKG_BSFIX_SOURCE_TAGS:-"javadoc javac xjavac javac.preset"}

# ------------------------------------------------------------------------------
# @global JAVA_ANT_IGNORE_SYSTEM_CLASSES
#
# Rewrites available tasks to ignore ant classpath.
#
# default: off
# ------------------------------------------------------------------------------

# ------------------------------------------------------------------------------
# @private java-ant_bsfix
#
# Attempts to fix build files. The following variables will affect its behavior
# as listed above:
# 	JAVA_PKG_BSFIX
#	JAVA_PKG_BSFIX_ALL
#	JAVA_PKG_BSFIX_NAME,
# ------------------------------------------------------------------------------
java-ant_bsfix() {
	debug-print-function ${FUNCNAME} $*

	[[ "${JAVA_PKG_BSFIX}" != "on" ]] && return
	if ! java-pkg_needs-vm; then
		echo "QA Notice: Package is using java-ant, but doesn't depend on a Java VM"
	fi

	pushd "${S}" >/dev/null

	local find_args=""
	[[ "${JAVA_PKG_BSFIX_ALL}" == "yes" ]] || find_args="-maxdepth 1"

	find_args="${find_args} -type f -name ${JAVA_PKG_BSFIX_NAME// / -o -name } "

	# This voodoo is done for paths with spaces
	local bsfix_these
	while read line; do
		[[ -z ${line} ]] && continue
		bsfix_these="${bsfix_these} '${line}'"
	done <<-EOF
			$(find . ${find_args})
		EOF

	[[ "${bsfix_these// /}" ]] && eval java-ant_bsfix_files ${bsfix_these}

	popd > /dev/null
}

_bsfix_die() {
	if has_version dev-python/pyxml; then
		eerror "If the output above contains:"
		eerror "ImportError:"
		eerror "/usr/lib/python2.4/site-packages/_xmlplus/parsers/pyexpat.so:"
		eerror "undefined symbol: PyUnicodeUCS2_DecodeUTF8"
		eerror "Try re-emerging dev-python/pyxml"
		die ${1} " Look at the eerror message above"
	else
		die ${1}
	fi
}

# ------------------------------------------------------------------------------
# @public java-ant_bsfix_files
#
# Attempts to fix named build files. The following variables will affect its behavior
# as listed above:
#	JAVA_PKG_BSFIX_SOURCE_TAGS
#	JAVA_PKG_BSFIX_TARGET_TAGS
#	JAVA_ANT_REWRITE_CLASSPATH
#	JAVA_ANT_JAVADOC_INPUT_DIRS: Where we can find java sources for javadoc
#                                input. Can be a space separated list of
#                                directories
#	JAVA_ANT_BSFIX_EXTRA_ARGS: You can use this to pass extra variables to the
#	                           rewriter if you know what you are doing.
#
# If JAVA_ANT_JAVADOC_INPUT_DIRS is set, we will turn on the adding of a basic
# javadoc target to the ant's build.xml with the javadoc xml-rewriter feature.
# Then we will set EANT DOC TARGET to the added javadoc target
# NOTE: the variable JAVA_ANT_JAVADOC_OUTPUT_DIR points where we will
#       generate the javadocs. This is a read-only variable, dont change it.

# When changing this function, make sure that it works with paths with spaces in
# them.
# ------------------------------------------------------------------------------
java-ant_bsfix_files() {
	debug-print-function ${FUNCNAME} $*

	[[ ${#} = 0 ]] && die "${FUNCNAME} called without arguments"

	local want_source="$(java-pkg_get-source)"
	local want_target="$(java-pkg_get-target)"

	debug-print "${FUNCNAME}: target: ${want_target} source: ${want_source}"

	if [ -z "${want_source}" -o -z "${want_target}" ]; then
		eerror "Could not find valid -source/-target values"
		eerror "Please file a bug about this on bugs.gentoo.org"
		die "Could not find valid -source/-target values"
	else
		local files

		[[ -x "/usr/bin/xml-rewrite-2.py" ]] && local using_new="true"

		for file in "${@}"; do
			debug-print "${FUNCNAME}: ${file}"

			if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
				cp "${file}" "${file}.orig" || die "failed to copy ${file}"
			fi

			if [[ ! -w "${file}" ]]; then
				chmod u+w "${file}" || die "chmod u+w ${file} failed"
			fi

			files="${files} -f '${file}'"

			if [[ -z "${using_new}" ]]; then
				echo "Rewriting $file (using xml-rewrite.py)"
				# Doing this twice because otherwise the source attributes would
				# get added to target tags too and javadoc does not like target
				xml-rewrite.py -f "${file}" \
					-c -e ${JAVA_PKG_BSFIX_SOURCE_TAGS// / -e } \
					-a source -v ${want_source} || _bsfix_die "xml-rewrite failed: ${file}"
				xml-rewrite.py -f "${file}" \
					-c -e ${JAVA_PKG_BSFIX_TARGET_TAGS// / -e } \
					-a target -v ${want_target} || _bsfix_die "xml-rewrite failed: ${file}"
			fi
		done

		if [[ "${using_new}" ]]; then
			# Play nice with paludis
			if [[ $(type -t quiet_mode) = function ]] && quiet_mode; then
				local output=">/dev/null"
			fi

			# for javadoc target and all in one pass, we need the new rewriter.
			local rewriter3="/usr/share/javatoolkit/xml-rewrite-3.py"
			if [[ ! -f ${rewriter3} ]]; then
				debug-print "Using second generation rewriter"
				eval echo "Rewriting source attributes" ${output}
				eval xml-rewrite-2.py ${files} \
					-c -e ${JAVA_PKG_BSFIX_SOURCE_TAGS// / -e } \
					-a source -v ${want_source} ${output} || _bsfix_die "xml-rewrite2 failed: ${file}"

				eval echo "Rewriting target attributes" ${output}
				eval xml-rewrite-2.py ${files} \
					-c -e ${JAVA_PKG_BSFIX_TARGET_TAGS// / -e } \
					-a target -v ${want_target} ${output} || _bsfix_die "xml-rewrite2 failed: ${file}"

				eval echo "Rewriting nowarn attributes" ${output}
				eval xml-rewrite-2.py ${files} \
					-c -e ${JAVA_PKG_BSFIX_TARGET_TAGS// / -e } \
					-a nowarn -v yes ${output} || _bsfix_die "xml-rewrite2 failed: ${file}"
			else
				debug-print "Using third generation rewriter"
				eval echo "Rewriting attributes" ${output}
				local bsfix_extra_args=""
				# WARNING KEEP THE ORDER, ESPECIALLY FOR CHANGED ATTRIBUTES!
				if [[ -n ${JAVA_ANT_REWRITE_CLASSPATH} ]]; then
					bsfix_extra_args="${bsfix_extra_args} -g -e javac -e xjavac "
					bsfix_extra_args="${bsfix_extra_args} -a classpath -v '\${gentoo.classpath}'"
				fi
				if [[ -n ${JAVA_ANT_JAVADOC_INPUT_DIRS} ]]; then
					if [[ -n ${JAVA_ANT_JAVADOC_OUTPUT_DIR} ]]; then
						die "Do not define JAVA_ANT_JAVADOC_OUTPUT_DIR!"
					fi
					# Where will our generated javadoc go.
					readonly JAVA_ANT_JAVADOC_OUTPUT_DIR=${WORKDIR}/gentoo_javadoc
					mkdir -p "${JAVA_ANT_JAVADOC_OUTPUT_DIR}" || die

					if hasq doc ${IUSE}; then
						if use doc; then
							if [[ -z ${EANT_DOC_TARGET} ]]; then
								EANT_DOC_TARGET="gentoojavadoc"
							else
								die "You can't use javadoc adding and set EANT_DOC_TARGET too."
							fi

							for dir in ${JAVA_ANT_JAVADOC_INPUT_DIRS};do
								if [[ ! -d ${dir} ]]; then
									eerror "This dir: ${dir} doesnt' exists"
									die "You must specify directories for javadoc input/output dirs."
								fi
							done
							bsfix_extra_args="${bsfix_extra_args} --javadoc --source-directory "
							# filter third/double spaces
							JAVA_ANT_JAVADOC_INPUT_DIRS=${JAVA_ANT_JAVADOC_INPUT_DIRS//   /}
							JAVA_ANT_JAVADOC_INPUT_DIRS=${JAVA_ANT_JAVADOC_INPUT_DIRS//  /}
							bsfix_extra_args="${bsfix_extra_args} ${JAVA_ANT_JAVADOC_INPUT_DIRS// / --source-directory }"
							bsfix_extra_args="${bsfix_extra_args} --output-directory ${JAVA_ANT_JAVADOC_OUTPUT_DIR}"
						fi
					else
						die "You need to have doc in IUSE when using JAVA_ANT_JAVADOC_INPUT_DIRS"
					fi
				fi

				[[ -n ${JAVA_ANT_BSFIX_EXTRA_ARGS} ]] \
					&& bsfix_extra_args="${bsfix_extra_args} ${JAVA_ANT_BSFIX_EXTRA_ARGS}"

				eval ${rewriter3}  ${files} \
					-c --source-element ${JAVA_PKG_BSFIX_SOURCE_TAGS// / --source-element } \
					--source-attribute source --source-value ${want_source} \
					--target-element   ${JAVA_PKG_BSFIX_TARGET_TAGS// / --target-element }  \
					--target-attribute target --target-value ${want_target} \
					--target-attribute nowarn --target-value yes \
					${bsfix_extra_args} \
					${output} || _bsfix_die "xml-rewrite2 failed: ${file}"
			fi
		fi

		if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
			for file in "${@}"; do
				diff -NurbB "${file}.orig" "${file}"
			done
		fi
	fi
	return 0 # so that the 1 for diff doesn't get reported
}


# ------------------------------------------------------------------------------
# @public java-ant_bsfix_one
#
# Attempts to fix named build file. The following variables will affect its behavior
# as listed above:
#	JAVA_PKG_BSFIX_SOURCE_TAGS
#	JAVA_PKG_BSFIX_TARGET_TAGS
# ------------------------------------------------------------------------------
java-ant_bsfix_one() {
	debug-print-function ${FUNCNAME} $*

	if [ -z "${1}" ]; then
		eerror "${FUNCNAME} needs one argument"
		die "${FUNCNAME} needs one argument"
	fi

	java-ant_bsfix_files "${1}"
}

# ------------------------------------------------------------------------------
# @public java-ant_rewrite-classpath
#
# Adds 'classpath="${gentoo.classpath}"' to specified build file.
# @param $1 - the file to rewrite (defaults to build.xml)
# ------------------------------------------------------------------------------
java-ant_rewrite-classpath() {
	debug-print-function ${FUNCNAME} $*

	local file="${1}"
	[[ -z "${1}" ]] && file=build.xml
	[[ ${#} -gt 1 ]] && die "${FUNCNAME} currently can only rewrite one file."

	echo "Adding gentoo.classpath to ${file}"
	debug-print "java-ant_rewrite-classpath: ${file}"

	cp "${file}" "${file}.orig" || die "failed to copy ${file}"

	chmod u+w "${file}"

	java-ant_xml-rewrite -f "${file}" --change -e javac -e xjavac -a classpath -v '${gentoo.classpath}'

	if [[ -n "${JAVA_PKG_DEBUG}" ]]; then
		diff -NurbB "${file}.orig" "${file}"
	fi
}

# ------------------------------------------------------------------------------
# @public java-ant_ignore-system-classes
#
# Makes the available task ignore classes in the system classpath
# @param $1 - the file to rewrite (defaults to build.xml)
# ------------------------------------------------------------------------------
java-ant_ignore-system-classes() {
	debug-print-function ${FUNCNAME} $*
	local file="${1}"
	[[ -z "${1}" ]] && file=build.xml
	echo "Changing ignoresystemclasses to true for available tasks"
	java-ant_xml-rewrite -f "${file}" --change \
		-e available -a ignoresystemclasses -v "true"
}

# ------------------------------------------------------------------------------
# @public java-ant_xml-rewrite
# Run the right xml-rewrite binary with the given arguments
# ------------------------------------------------------------------------------
java-ant_xml-rewrite() {
	local bindir="${ROOT}/usr/bin/"
	local gen2="${bindir}/xml-rewrite-2.py"
	local gen1="${bindir}/xml-rewrite.py"
	if [[ -x "${gen2}" ]]; then
		${gen2} "${@}" || die "${gen2} failed"
	elif [[ -x "${gen1}" ]]; then
		${gen1} "${@}" || die "${gen1} failed"
	else
		eerror "No binary for rewriting found."
		eerror "Do you have dev-java/javatoolkit installed?"
		die "xml-rewrite not found"
	fi
}