# eclass for ant based Java packages
#
# Copyright (c) 2004-2005, Thomas Matthijs <axxo@gentoo.org>
# Copyright (c) 2004-2005, Gentoo Foundation
#
# Licensed under the GNU General Public License, v2
#

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.

# Only exports src_unpack
EXPORT_FUNCTIONS src_unpack

# We need some tools from java-toolkit
DEPEND=">=dev-java/javatoolkit-0.1.5"

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

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

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

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

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

# ------------------------------------------------------------------------------
# @public java-ant_src_unpack
#
# Unpacks the source, and attempts to fix build files.
# ------------------------------------------------------------------------------
java-ant-2_src_unpack() {
	ant_src_unpack
	java-ant_bsfix
}

# ------------------------------------------------------------------------------
# @private ant_src_unpack
#
# Helper function which does the actual unpacking
# ------------------------------------------------------------------------------
# TODO maybe use base.eclass for some patching love?
ant_src_unpack() {
	debug-print-function ${FUNCNAME} $*
	if [[ -n "${A}" ]]; then
		unpack ${A}
	fi
}

# ------------------------------------------------------------------------------
# @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_PKG_BSFIX_SOURCE_TAGS
#	JAVA_PKG_BSFIX_TARGET_TAGS)
# ------------------------------------------------------------------------------
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

	cd "${S}"
	
	local find_args="-type f"
	if [[ "${JAVA_PKG_BSFIX_ALL}" == "yes" ]]; then
		find_args="${find_args} -name ${JAVA_PKG_BSFIX_NAME// / -o -name }"
	else
		find_args="${find_args} -maxdepth 1 -name ${JAVA_PKG_BSFIX_NAME// / -o -name } "
	fi

	local i=0
	local -a bsfix_these
	while read line; do
		[[ -z ${line} ]] && continue
		bsfix_these[${i}]="${line}"
		let i+=1
	done <<-EOF 
			$(find ${find_args})
		EOF

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

	debug-print "bsfix: 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
		for (( i = 0 ; i < ${#bsfix_these[@]} ; i++ )); do
			local file="${bsfix_these[${i}]}"
			echo "Rewriting ${file}"
			debug-print "bsfix: ${file}"

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

			chmod u+w "${file}"

			xml-rewrite.py -f "${file}" -c -e ${JAVA_PKG_BSFIX_SOURCE_TAGS// / -e } -a source -v ${want_source} || die "xml-rewrite failed: ${file}"
			xml-rewrite.py -f "${file}" -c -e ${JAVA_PKG_BSFIX_TARGET_TAGS// / -e } -a target -v ${want_target} || die "xml-rewrite failed: ${file}"

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