/[gentoo-x86]/eclass/autotools-utils.eclass
Gentoo

Contents of /eclass/autotools-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.22 - (hide annotations) (download)
Sun Sep 18 07:57:55 2011 UTC (2 years, 11 months ago) by mgorny
Branch: MAIN
Changes since 1.21: +4 -1 lines
Fail if myeconfargs is not an array.

1 reavertm 1.1 # Copyright 1999-2010 Gentoo Foundation
2     # Distributed under the terms of the GNU General Public License v2
3 mgorny 1.22 # $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.21 2011/09/18 07:57:34 mgorny Exp $
4 reavertm 1.1
5     # @ECLASS: autotools-utils.eclass
6     # @MAINTAINER:
7     # Maciej Mrozowski <reavertm@gentoo.org>
8 reavertm 1.10 # Michał Górny <mgorny@gentoo.org>
9 reavertm 1.1 # @BLURB: common ebuild functions for autotools-based packages
10     # @DESCRIPTION:
11     # autotools-utils.eclass is autotools.eclass(5) and base.eclass(5) wrapper
12     # providing all inherited features along with econf arguments as Bash array,
13     # out of source build with overridable build dir location, static archives
14     # handling, libtool files removal, enable/disable debug handling.
15     #
16     # @EXAMPLE:
17     # Typical ebuild using autotools-utils.eclass:
18     #
19     # @CODE
20     # EAPI="2"
21     #
22     # inherit autotools-utils
23     #
24     # DESCRIPTION="Foo bar application"
25     # HOMEPAGE="http://example.org/foo/"
26     # SRC_URI="mirror://sourceforge/foo/${P}.tar.bz2"
27     #
28     # LICENSE="LGPL-2.1"
29     # KEYWORDS=""
30     # SLOT="0"
31     # IUSE="debug doc examples qt4 static-libs tiff"
32     #
33     # CDEPEND="
34     # media-libs/libpng:0
35     # qt4? (
36     # x11-libs/qt-core:4
37     # x11-libs/qt-gui:4
38     # )
39     # tiff? ( media-libs/tiff:0 )
40     # "
41     # RDEPEND="${CDEPEND}
42     # !media-gfx/bar
43     # "
44     # DEPEND="${CDEPEND}
45     # doc? ( app-doc/doxygen )
46     # "
47     #
48     # # bug 123456
49     # AUTOTOOLS_IN_SOURCE_BUILD=1
50     #
51     # DOCS=(AUTHORS ChangeLog README "Read me.txt" TODO)
52     #
53     # PATCHES=(
54     # "${FILESDIR}/${P}-gcc44.patch" # bug 123458
55     # "${FILESDIR}/${P}-as-needed.patch"
56     # "${FILESDIR}/${P}-unbundle_libpng.patch"
57     # )
58     #
59     # src_configure() {
60 reavertm 1.6 # local myeconfargs=(
61 reavertm 1.1 # $(use_with qt4)
62     # $(use_enable threads multithreading)
63     # $(use_with tiff)
64     # )
65     # autotools-utils_src_configure
66     # }
67     #
68     # src_compile() {
69     # autotools-utils_src_compile
70     # use doc && autotools-utils_src_compile docs
71     # }
72     #
73     # src_install() {
74     # use doc && HTML_DOCS=("${AUTOTOOLS_BUILD_DIR}/apidocs/html/")
75     # autotools-utils_src_install
76     # if use examples; then
77     # dobin "${AUTOTOOLS_BUILD_DIR}"/foo_example{1,2,3} \\
78     # || die 'dobin examples failed'
79     # fi
80     # }
81     #
82     # @CODE
83    
84     # Keep variable names synced with cmake-utils and the other way around!
85    
86     case ${EAPI:-0} in
87 scarabeus 1.8 2|3|4) ;;
88 reavertm 1.2 *) die "EAPI=${EAPI} is not supported" ;;
89 reavertm 1.1 esac
90    
91 mgorny 1.21 inherit autotools base eutils
92 reavertm 1.1
93     EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
94    
95     # @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR
96     # @DESCRIPTION:
97     # Build directory, location where all autotools generated files should be
98     # placed. For out of source builds it defaults to ${WORKDIR}/${P}_build.
99    
100     # @ECLASS-VARIABLE: AUTOTOOLS_IN_SOURCE_BUILD
101     # @DESCRIPTION:
102     # Set to enable in-source build.
103    
104     # @ECLASS-VARIABLE: ECONF_SOURCE
105     # @DESCRIPTION:
106     # Specify location of autotools' configure script. By default it uses ${S}.
107    
108     # @ECLASS-VARIABLE: myeconfargs
109     # @DESCRIPTION:
110     # Optional econf arguments as Bash array. Should be defined before calling src_configure.
111     # @CODE
112     # src_configure() {
113 reavertm 1.7 # local myeconfargs=(
114 reavertm 1.1 # --disable-readline
115     # --with-confdir="/etc/nasty foo confdir/"
116     # $(use_enable debug cnddebug)
117     # $(use_enable threads multithreading)
118     # )
119     # autotools-utils_src_configure
120     # }
121     # @CODE
122    
123     # Determine using IN or OUT source build
124     _check_build_dir() {
125     : ${ECONF_SOURCE:=${S}}
126     if [[ -n ${AUTOTOOLS_IN_SOURCE_BUILD} ]]; then
127     AUTOTOOLS_BUILD_DIR="${ECONF_SOURCE}"
128     else
129     : ${AUTOTOOLS_BUILD_DIR:=${WORKDIR}/${P}_build}
130     fi
131     echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\""
132     }
133    
134     # @FUNCTION: remove_libtool_files
135 mgorny 1.14 # @USAGE: [all]
136 reavertm 1.1 # @DESCRIPTION:
137     # Determines unnecessary libtool files (.la) and libtool static archives (.a)
138     # and removes them from installation image.
139 mgorny 1.14 #
140 reavertm 1.1 # To unconditionally remove all libtool files, pass 'all' as argument.
141 mgorny 1.14 # Otherwise, libtool archives required for static linking will be preserved.
142 reavertm 1.1 #
143     # In most cases it's not necessary to manually invoke this function.
144     # See autotools-utils_src_install for reference.
145     remove_libtool_files() {
146     debug-print-function ${FUNCNAME} "$@"
147 mgorny 1.16 local removing_all
148     [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
149     if [[ ${#} -eq 1 ]]; then
150     case "${1}" in
151     all)
152     removing_all=1
153     ;;
154     *)
155     die "Invalid argument to ${FUNCNAME}(): ${1}"
156     esac
157     fi
158 reavertm 1.1
159 mgorny 1.19 local pc_libs=()
160     if [[ ! ${removing_all} ]]; then
161     local arg
162     for arg in $(find "${D}" -name '*.pc' -exec \
163     sed -n -e 's;^Libs:;;p' {} +); do
164     [[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
165     done
166     fi
167    
168 reavertm 1.1 local f
169 mgorny 1.12 find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do
170 reavertm 1.1 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
171 mgorny 1.14 local archivefile=${f/%.la/.a}
172 mgorny 1.15 [[ "${f}" != "${archivefile}" ]] || die 'regex sanity check failed'
173 mgorny 1.14
174 mgorny 1.18 # Remove static libs we're not supposed to link against.
175 mgorny 1.17 if [[ ${shouldnotlink} ]]; then
176     einfo "Removing unnecessary ${archivefile#${D%/}}"
177     rm -f "${archivefile}" || die
178 mgorny 1.18 # The .la file may be used by a module loader, so avoid removing it
179     # unless explicitly requested.
180 mgorny 1.17 [[ ${removing_all} ]] || continue
181     fi
182    
183 mgorny 1.18 # Remove .la files when:
184     # - user explicitly wants us to remove all .la files,
185     # - respective static archive doesn't exist,
186 mgorny 1.19 # - they are covered by a .pc file already,
187 mgorny 1.18 # - they don't provide any new information (no libs & no flags).
188     local removing
189 mgorny 1.20 if [[ ${removing_all} ]]; then removing='forced'
190     elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
191     elif has "$(basename "${f}")" "${pc_libs[@]}"; then
192     removing='covered by .pc'
193 mgorny 1.18 elif [[ ! $(sed -n -e \
194     "s/^\(dependency_libs\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
195 mgorny 1.20 "${f}") ]]; then removing='no libs & flags'
196 mgorny 1.18 fi
197    
198     if [[ ${removing} ]]; then
199 mgorny 1.20 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
200 mgorny 1.15 rm -f "${f}" || die
201 reavertm 1.1 fi
202     done
203     }
204    
205     # @FUNCTION: autotools-utils_src_prepare
206     # @DESCRIPTION:
207     # The src_prepare function.
208     #
209     # Supporting PATCHES array and user patches. See base.eclass(5) for reference.
210     autotools-utils_src_prepare() {
211     debug-print-function ${FUNCNAME} "$@"
212    
213     base_src_prepare
214     }
215    
216     # @FUNCTION: autotools-utils_src_configure
217     # @DESCRIPTION:
218     # The src_configure function. For out of source build it creates build
219     # directory and runs econf there. Configuration parameters defined
220     # in myeconfargs are passed here to econf. Additionally following USE
221     # flags are known:
222     #
223     # IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
224     # to econf respectively.
225     autotools-utils_src_configure() {
226     debug-print-function ${FUNCNAME} "$@"
227    
228 mgorny 1.22 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
229     || die 'autotools-utils.eclass: myeconfargs has to be an array.'
230    
231 reavertm 1.1 # Common args
232     local econfargs=()
233    
234     # Handle debug found in IUSE
235     if has debug ${IUSE//+}; then
236 mgorny 1.21 local debugarg=$(use_enable debug)
237     if ! has "${debugarg}" "${myeconfargs[@]}"; then
238     eqawarn 'Implicit $(use_enable debug) for IUSE="debug" is no longer supported.'
239     eqawarn 'Please add the necessary arg to myeconfargs if requested.'
240     eqawarn 'The autotools-utils eclass will stop warning about it on Oct 15th.'
241     fi
242 reavertm 1.1 fi
243    
244     # Handle static-libs found in IUSE, disable them by default
245     if has static-libs ${IUSE//+}; then
246     econfargs+=(
247     --enable-shared
248     $(use_enable static-libs static)
249     )
250     fi
251    
252     # Append user args
253 reavertm 1.5 econfargs+=("${myeconfargs[@]}")
254 reavertm 1.1
255     _check_build_dir
256     mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
257     pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
258 reavertm 1.4 base_src_configure "${econfargs[@]}" "$@"
259 reavertm 1.1 popd > /dev/null
260     }
261    
262     # @FUNCTION: autotools-utils_src_compile
263     # @DESCRIPTION:
264     # The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
265     autotools-utils_src_compile() {
266     debug-print-function ${FUNCNAME} "$@"
267    
268     _check_build_dir
269     pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
270     base_src_compile "$@"
271     popd > /dev/null
272     }
273    
274     # @FUNCTION: autotools-utils_src_install
275     # @DESCRIPTION:
276     # The autotools src_install function. Runs emake install, unconditionally
277     # removes unnecessary static libs (based on shouldnotlink libtool property)
278     # and removes unnecessary libtool files when static-libs USE flag is defined
279     # and unset.
280     #
281     # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
282     autotools-utils_src_install() {
283     debug-print-function ${FUNCNAME} "$@"
284    
285     _check_build_dir
286     pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
287 reavertm 1.9 base_src_install "$@"
288 reavertm 1.1 popd > /dev/null
289    
290     # Remove libtool files and unnecessary static libs
291 mgorny 1.14 remove_libtool_files
292 reavertm 1.1 }
293    
294     # @FUNCTION: autotools-utils_src_test
295     # @DESCRIPTION:
296     # The autotools src_test function. Runs emake check in build directory.
297     autotools-utils_src_test() {
298     debug-print-function ${FUNCNAME} "$@"
299    
300     _check_build_dir
301     pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
302     # Run default src_test as defined in ebuild.sh
303     default_src_test
304     popd > /dev/null
305     }

  ViewVC Help
Powered by ViewVC 1.1.20