ant-tasks.eclass: cleanup and improvement
[gentoo.git] / eclass / ant-tasks.eclass
1 # Copyright 1999-2019 Gentoo Authors
2 # Distributed under the terms of the GNU General Public License, v2 or later
3
4 # @ECLASS: ant-tasks.eclass
5 # @MAINTAINER:
6 # java@gentoo.org
7 # @AUTHOR:
8 # Vlastimil Babka <caster@gentoo.org>
9 # @BLURB: Eclass for building dev-java/ant-* packages
10 # @DESCRIPTION:
11 # This eclass provides functionality and default ebuild variables for building
12 # dev-java/ant-* packages easily.
13
14 case "${EAPI:-0}" in
15         0|1|2|3|4)
16                 die "ant-tasks.eclass: EAPI ${EAPI} is too old."
17                 ;;
18         5|6|7)
19                 ;;
20         *)
21                 die "ant-tasks.eclass: EAPI ${EAPI} is not supported yet."
22                 ;;
23 esac
24
25 # we set ant-core dep ourselves, restricted
26 JAVA_ANT_DISABLE_ANT_CORE_DEP=true
27 # rewriting build.xml for are the testcases has no reason atm
28 JAVA_PKG_BSFIX_ALL=no
29 inherit java-pkg-2 java-ant-2
30 [[ ${EAPI:-0} == [56] ]] && inherit eapi7-ver
31
32 EXPORT_FUNCTIONS src_unpack src_compile src_install
33
34 # @ECLASS-VARIABLE: ANT_TASK_JDKVER
35 # @DESCRIPTION:
36 # Affects the >=virtual/jdk version set in DEPEND string. Defaults to 1.8, can
37 # be overridden from ebuild BEFORE inheriting this eclass.
38 ANT_TASK_JDKVER=${ANT_TASK_JDKVER-1.8}
39
40 # @ECLASS-VARIABLE: ANT_TASK_JREVER
41 # @DESCRIPTION:
42 # Affects the >=virtual/jre version set in DEPEND string. Defaults to 1.8, can
43 # be overridden from ebuild BEFORE inheriting this eclass.
44 ANT_TASK_JREVER=${ANT_TASK_JREVER-1.8}
45
46 # @ECLASS-VARIABLE: ANT_TASK_NAME
47 # @DESCRIPTION:
48 # The name of this ant task as recognized by ant's build.xml, derived from $PN
49 # by removing the ant- prefix. Read-only.
50 ANT_TASK_NAME="${PN#ant-}"
51
52 # @ECLASS-VARIABLE: ANT_TASK_DEPNAME
53 # @DESCRIPTION:
54 # Specifies JAVA_PKG_NAME (PN{-SLOT} used with java-pkg_jar-from) of the package
55 # that this one depends on. Defaults to the name of ant task, ebuild can
56 # override it before inheriting this eclass.
57 ANT_TASK_DEPNAME=${ANT_TASK_DEPNAME-${ANT_TASK_NAME}}
58
59 # @ECLASS-VARIABLE: ANT_TASK_DISABLE_VM_DEPS
60 # @DEFAULT_UNSET
61 # @DESCRIPTION:
62 # If set, no JDK/JRE deps are added.
63
64 # @VARIABLE: ANT_TASK_PV
65 # @INTERNAL
66 # Version of ant-core this task is intended to register and thus load with.
67 ANT_TASK_PV="${PV}"
68
69 # default for final releases
70 MY_PV=${PV}
71 case ${PV} in
72 1.9.2)
73         UPSTREAM_PREFIX="https://archive.apache.org/dist/ant/source"
74         GENTOO_PREFIX="https://dev.gentoo.org/~tomwij/files/dist"
75         ;;
76 *)
77         UPSTREAM_PREFIX="mirror://apache/ant/source"
78         GENTOO_PREFIX="https://dev.gentoo.org/~fordfrog/distfiles"
79         ;;
80 esac
81
82 # source/workdir name
83 MY_P="apache-ant-${MY_PV}"
84
85 # Default values for standard ebuild variables, can be overridden from ebuild.
86 DESCRIPTION="Apache Ant's optional tasks depending on ${ANT_TASK_DEPNAME}"
87 HOMEPAGE="http://ant.apache.org/"
88 SRC_URI="${UPSTREAM_PREFIX}/${MY_P}-src.tar.bz2
89         ${GENTOO_PREFIX}/ant-${PV}-gentoo.tar.bz2"
90 LICENSE="Apache-2.0"
91 SLOT="0"
92
93 RDEPEND="~dev-java/ant-core-${PV}:0"
94 DEPEND="${RDEPEND}"
95
96 if [[ -z "${ANT_TASK_DISABLE_VM_DEPS}" ]]; then
97         RDEPEND+=" >=virtual/jre-${ANT_TASK_JREVER}"
98         DEPEND+=" >=virtual/jdk-${ANT_TASK_JDKVER}"
99 fi
100
101 # Would run the full ant test suite for every ant task
102 RESTRICT="test"
103
104 S="${WORKDIR}/${MY_P}"
105
106 # @FUNCTION: ant-tasks_src_unpack
107 # @USAGE: [ base ] [ jar-dep ] [ all ]
108 # @DESCRIPTION:
109 # The function Is split into two parts, defaults to both of them ('all').
110 #
111 # base: performs the unpack, build.xml replacement and symlinks ant.jar from
112 #       ant-core
113 #
114 # jar-dep: symlinks the jar file(s) from dependency package
115 ant-tasks_src_unpack() {
116         [[ -z "${1}" ]] && ant-tasks_src_unpack all
117
118         while [[ -n "${1}" ]]; do
119                 case ${1} in
120                         base)
121                                 unpack ${A}
122                                 cd "${S}"
123
124                                 # replace build.xml with our modified for split building
125                                 if [ -e "${WORKDIR}"/${PV}-build.patch ] ; then
126                                         if [ ${EAPI:-0} -eq 5 ]; then
127                                                 die "ant-tasks.eclass: build.xml patching not supported for EAPI 5 ebuilds"
128                                         fi
129
130                                         eapply "${WORKDIR}"/${PV}-build.patch
131                                 else
132                                         mv -f "${WORKDIR}"/build.xml .
133                                 fi
134
135                                 cd lib
136                                 # remove bundled xerces
137                                 rm -f *.jar
138
139                                 # ant.jar to build against
140                                 java-pkg_jar-from --build-only ant-core ant.jar;;
141                         jar-dep)
142                                 # get jar from the dependency package
143                                 if [[ -n "${ANT_TASK_DEPNAME}" ]]; then
144                                         java-pkg_jar-from ${ANT_TASK_DEPNAME}
145                                 fi;;
146                         all)
147                                 ant-tasks_src_unpack base jar-dep;;
148                 esac
149                 shift
150         done
151
152 }
153
154 # @FUNCTION: ant-tasks_src_compile
155 # @DESCRIPTION:
156 # Compiles the jar with installed ant-core.
157 ant-tasks_src_compile() {
158         ANT_TASKS="none" eant -Dbuild.dep=${ANT_TASK_NAME} jar-dep
159 }
160
161 # @FUNCTION: ant-tasks_src_install
162 # @DESCRIPTION:
163 # Installs the jar and registers its presence for the ant launcher script.
164 # Version param ensures it won't get loaded (thus break) when ant-core is
165 # updated to newer version.
166 ant-tasks_src_install() {
167         java-pkg_dojar build/lib/${PN}.jar
168         java-pkg_register-ant-task --version "${ANT_TASK_PV}"
169
170         # create the compatibility symlink
171         dodir /usr/share/ant/lib
172         dosym /usr/share/${PN}/lib/${PN}.jar /usr/share/ant/lib/${PN}.jar
173 }