# Copyright 2004-2024 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: java-ant-2.eclass # @MAINTAINER: # java@gentoo.org # @AUTHOR: # kiorky <kiorky@cryptelium.net> # Petteri Räty <betelgeuse@gentoo.org> # @SUPPORTED_EAPIS: 7 8 # @PROVIDES: java-utils-2 # @BLURB: eclass for ant based Java packages # @DEPRECATED: none # @DESCRIPTION: # Eclass for Ant-based Java packages. Provides support for both automatic and # manual manipulation of build.xml files. Should be inherited after java-pkg-2 # or java-pkg-opt-2 eclass. case ${EAPI} in 7|8) ;; *) die "${ECLASS}: EAPI ${EAPI:-0} not supported" ;; esac if [[ -z ${_JAVA_ANT_2_ECLASS} ]] ; then _JAVA_ANT_2_ECLASS=1 inherit java-utils-2 multilib # 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. # @ECLASS_VARIABLE: WANT_ANT_TASKS # @DEFAULT_UNSET # @DESCRIPTION: # An $IFS separated list of ant tasks. # Ebuild can specify this variable before inheriting java-ant-2 eclass to # determine ANT_TASKS it needs. They will be automatically translated to # DEPEND variable and ANT_TASKS variable. JAVA_PKG_FORCE_ANT_TASKS can override # ANT_TASKS set by WANT_ANT_TASKS, but not the DEPEND due to caching. # Ebuilds that need to depend conditionally on certain tasks and specify them # differently for different eant calls can't use this simplified approach. # You also cannot specify version or anything else than ant-*. # # @CODE # WANT_ANT_TASKS="ant-junit ant-trax" # @CODE #The implementation of dependencies is handled by java-utils-2.eclass #WANT_ANT_TASKS # @VARIABLE: JAVA_ANT_E_DEPEND # @INTERNAL # @DESCRIPTION: # Convenience variable adding packages to DEPEND so they need not be added # in the ebuild. JAVA_ANT_E_DEPEND+=" >=dev-java/ant-1.10.14-r2:0" # add ant tasks specified in WANT_ANT_TASKS to 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 # We need some tools from javatoolkit. We also need ant dependencies # constructed above. JAVA_ANT_E_DEPEND="${JAVA_ANT_E_DEPEND} ${ANT_TASKS_DEPEND} dev-java/javatoolkit" unset 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 has java-pkg-opt-2 ${INHERITED}; then JAVA_ANT_E_DEPEND="${JAVA_PKG_OPT_USE}? ( ${JAVA_ANT_E_DEPEND} )" elif ! has java-pkg-2 ${INHERITED}; then eerror "java-ant-2 eclass can only be inherited AFTER java-pkg-2 or java-pkg-opt-2" fi DEPEND="${JAVA_ANT_E_DEPEND}" # @ECLASS_VARIABLE: JAVA_PKG_BSFIX # @DESCRIPTION: # Should we attempt to 'fix' ant build files to include the source/target # attributes when calling javac? JAVA_PKG_BSFIX=${JAVA_PKG_BSFIX:-"on"} # @ECLASS_VARIABLE: JAVA_PKG_BSFIX_ALL # @DESCRIPTION: # If we're fixing build files, should we try to fix all the ones we can find? JAVA_PKG_BSFIX_ALL=${JAVA_PKG_BSFIX_ALL:-"yes"} # @ECLASS_VARIABLE: JAVA_PKG_BSFIX_NAME # @DESCRIPTION: # Filename of build files to fix/search for JAVA_PKG_BSFIX_NAME=${JAVA_PKG_BSFIX_NAME:-"build.xml"} # @ECLASS_VARIABLE: JAVA_PKG_BSFIX_TARGET_TAGS # @DESCRIPTION: # Targets to fix the 'source' attribute in JAVA_PKG_BSFIX_TARGET_TAGS=${JAVA_PKG_BSFIX_TARGET_TAGS:-"javac xjavac javac.preset"} # @ECLASS_VARIABLE: JAVA_PKG_BSFIX_SOURCE_TAGS # @DESCRIPTION: # Targets to fix the 'target' attribute in JAVA_PKG_BSFIX_SOURCE_TAGS=${JAVA_PKG_BSFIX_SOURCE_TAGS:-"javadoc javac xjavac javac.preset"} # @ECLASS_VARIABLE: JAVA_ANT_CLASSPATH_TAGS # @DESCRIPTION: # Targets to add the classpath attribute to JAVA_ANT_CLASSPATH_TAGS="javac xjavac" # @ECLASS_VARIABLE: JAVA_ANT_IGNORE_SYSTEM_CLASSES # @DEFAULT_UNSET # @DESCRIPTION: # When set, <available> Ant tasks are rewritten to ignore Ant's runtime classpath. # @FUNCTION: java-ant-2_src_configure # @DESCRIPTION: # src_configure rewrites the build.xml files automatically. java-ant-2_src_configure() { # if java support is optional, don't perform this when the USE flag is off if has java-pkg-opt-2 ${INHERITED}; then use ${JAVA_PKG_OPT_USE} || return fi # eant will call us unless called by Portage [[ -e "${T}/java-ant-2_src_configure-run" ]] && return [[ "${JAVA_ANT_IGNORE_SYSTEM_CLASSES}" ]] \ && java-ant_ignore-system-classes "${S}/build.xml" java-ant_bsfix touch "${T}/java-ant-2_src_configure-run" } # @FUNCTION: java-ant_bsfix # @INTERNAL # @DESCRIPTION: # Attempts to fix build files. # # @CODE # Affected by variables: # JAVA_PKG_BSFIX # JAVA_PKG_BSFIX_ALL # JAVA_PKG_BSFIX_NAME, # @CODE 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 || die 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 } )" local bsfix_these=() line while IFS= read -r -d $'\0' line; do bsfix_these+=( "${line}" ) done < <(find . ${find_args} -print0) [[ "${bsfix_these[@]}" ]] && java-ant_bsfix_files "${bsfix_these[@]}" popd > /dev/null || die } # @FUNCTION: java-ant_bsfix_files # @USAGE: <path/to/first/build.xml> [path/to/second.build.xml ...] # @DESCRIPTION: # Attempts to fix named build files. # # @CODE # Affected by variables: # 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. # @CODE # # 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=() 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+=( -f "${file}" ) done if [ -e "${EPREFIX}/usr/libexec/javatoolkit" ]; then local rewriter3="${EPREFIX}/usr/libexec/javatoolkit/xml-rewrite-3.py" local rewriter4="${EPREFIX}/usr/libexec/javatoolkit/build-xml-rewrite" else local rewriter3="${EPREFIX}/usr/$(get_libdir)/javatoolkit/bin/xml-rewrite-3.py" local rewriter4="${EPREFIX}/usr/$(get_libdir)/javatoolkit/bin/build-xml-rewrite" fi if [[ -x ${rewriter4} && ${JAVA_ANT_ENCODING} ]]; then [[ ${JAVA_ANT_REWRITE_CLASSPATH} ]] && local gcp="-g" [[ ${JAVA_ANT_ENCODING} ]] && local enc="-e ${JAVA_ANT_ENCODING}" echo "cElementTree rewriter" debug-print "${rewriter4} extra args: ${gcp} ${enc}" ${rewriter4} ${gcp} ${enc} \ -c "${JAVA_PKG_BSFIX_SOURCE_TAGS}" source ${want_source} \ -c "${JAVA_PKG_BSFIX_TARGET_TAGS}" target ${want_target} \ "${@}" || die "build-xml-rewrite failed" else debug-print "Using third generation rewriter" echo "Rewriting attributes" local bsfix_extra_args=() # WARNING KEEP THE ORDER, ESPECIALLY FOR CHANGED ATTRIBUTES! if [[ -n ${JAVA_ANT_REWRITE_CLASSPATH} ]]; then local cp_tags="${JAVA_ANT_CLASSPATH_TAGS// / -e }" bsfix_extra_args+=( -g -e ${cp_tags} ) 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 has 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 "Directory ${dir} doesn't exist" die "You must specify directories for javadoc input/output dirs." fi done 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+=( ${JAVA_ANT_JAVADOC_INPUT_DIRS// / --source-directory } ) 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+=( ${JAVA_ANT_BSFIX_EXTRA_ARGS} ) debug-print "bsfix_extra_args: ${bsfix_extra_args[*]}" ${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[@]}" \ || die "xml-rewrite-3 failed: ${file}" 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 } # @FUNCTION: java-ant_bsfix_one # @USAGE: <path/to/build.xml> # @DESCRIPTION: # Attempts to fix named build file. # # @CODE # Affected by variables: # JAVA_PKG_BSFIX_SOURCE_TAGS # JAVA_PKG_BSFIX_TARGET_TAGS # @CODE 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}" } # @FUNCTION: java-ant_rewrite-classpath # @USAGE: [path/to/build.xml] # @DESCRIPTION: # Adds 'classpath="${gentoo.classpath}"' to specified build file. # # Affected by: # JAVA_ANT_CLASSPATH_TAGS # # Parameter defaults to build.xml when not specified 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 ${JAVA_ANT_CLASSPATH_TAGS// / -e } -a classpath -v '${gentoo.classpath}' if [[ -n "${JAVA_PKG_DEBUG}" ]]; then diff -NurbB "${file}.orig" "${file}" fi } # @FUNCTION: java-ant_ignore-system-classes # @USAGE: [path/to/build.xml] # @DESCRIPTION: # Makes the available task ignore classes in the system classpath # Parameter defaults to build.xml when not specified java-ant_ignore-system-classes() { debug-print-function ${FUNCNAME} $* local file=${1:-build.xml} echo "Changing ignoresystemclasses to true for available tasks in ${file}" java-ant_xml-rewrite -f "${file}" --change \ -e available -a ignoresystemclasses -v "true" } # @FUNCTION: java-ant_xml-rewrite # @USAGE: <xml rewriter arguments> # @DESCRIPTION: # Run the right xml-rewrite binary with the given arguments java-ant_xml-rewrite() { local gen2_1="${EPREFIX}/usr/$(get_libdir)/javatoolkit/bin/xml-rewrite-2.py" local gen2_2="${EPREFIX}/usr/libexec/javatoolkit/xml-rewrite-2.py" # gen1 is deprecated if [[ -x "${gen2_2}" ]]; then ${gen2_2} "${@}" || die "${gen2_2} failed" elif [[ -x "${gen2_1}" ]]; then ${gen2_1} "${@}" || die "${gen2_1} failed" else eerror "No binary for rewriting found." eerror "Do you have dev-java/javatoolkit installed?" die "xml-rewrite not found" fi } # @FUNCTION: java-ant_rewrite-bootclasspath # @USAGE: <version> [path/to/build.xml] [prepend] [append] # @DESCRIPTION: # Adds bootclasspath to javac-like tasks in build.xml filled with jars of a # bootclasspath package of given version. # # @CODE # Affected by: # JAVA_PKG_BSFIX_TARGET_TAGS - the tags of javac tasks # # Parameters: # $1 - the version of bootclasspath (e.g. 1.5), 'auto' for bootclasspath # of the current JDK # $2 - path to desired build.xml file, defaults to 'build.xml' # $3 - (optional) what to prepend the bootclasspath with (to override) # $4 - (optional) what to append to the bootclasspath # @CODE java-ant_rewrite-bootclasspath() { local version="${1}" local file="${2-build.xml}" local extra_before="${3}" local extra_after="${4}" local bcp="$(java-pkg_get-bootclasspath "${version}")" if [[ -n "${extra_before}" ]]; then bcp="${extra_before}:${bcp}" fi if [[ -n "${extra_after}" ]]; then bcp="${bcp}:${extra_after}" fi java-ant_xml-rewrite -f "${file}" -c -e ${JAVA_PKG_BSFIX_TARGET_TAGS// / -e } \ -a bootclasspath -v "${bcp}" } fi EXPORT_FUNCTIONS src_configure