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

Diff of /eclass/autotools-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.8 Revision 1.28
1# Copyright 1999-2010 Gentoo Foundation 1# Copyright 1999-2011 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.8 2011/01/31 14:09:01 scarabeus Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.28 2011/11/27 09:17:35 mgorny Exp $
4 4
5# @ECLASS: autotools-utils.eclass 5# @ECLASS: autotools-utils.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# Maciej Mrozowski <reavertm@gentoo.org> 7# Maciej Mrozowski <reavertm@gentoo.org>
8# Michał Górny <mgorny@gentoo.org>
8# @BLURB: common ebuild functions for autotools-based packages 9# @BLURB: common ebuild functions for autotools-based packages
9# @DESCRIPTION: 10# @DESCRIPTION:
10# autotools-utils.eclass is autotools.eclass(5) and base.eclass(5) wrapper 11# autotools-utils.eclass is autotools.eclass(5) and base.eclass(5) wrapper
11# providing all inherited features along with econf arguments as Bash array, 12# providing all inherited features along with econf arguments as Bash array,
12# out of source build with overridable build dir location, static archives 13# out of source build with overridable build dir location, static archives
13# handling, libtool files removal, enable/disable debug handling. 14# handling, libtool files removal.
15#
16# Please note note that autotools-utils does not support mixing of its phase
17# functions with regular econf/emake calls. If necessary, please call
18# autotools-utils_src_compile instead of the latter.
14# 19#
15# @EXAMPLE: 20# @EXAMPLE:
16# Typical ebuild using autotools-utils.eclass: 21# Typical ebuild using autotools-utils.eclass:
17# 22#
18# @CODE 23# @CODE
55# "${FILESDIR}/${P}-unbundle_libpng.patch" 60# "${FILESDIR}/${P}-unbundle_libpng.patch"
56# ) 61# )
57# 62#
58# src_configure() { 63# src_configure() {
59# local myeconfargs=( 64# local myeconfargs=(
65# $(use_enable debug)
60# $(use_with qt4) 66# $(use_with qt4)
61# $(use_enable threads multithreading) 67# $(use_enable threads multithreading)
62# $(use_with tiff) 68# $(use_with tiff)
63# ) 69# )
64# autotools-utils_src_configure 70# autotools-utils_src_configure
85case ${EAPI:-0} in 91case ${EAPI:-0} in
86 2|3|4) ;; 92 2|3|4) ;;
87 *) die "EAPI=${EAPI} is not supported" ;; 93 *) die "EAPI=${EAPI} is not supported" ;;
88esac 94esac
89 95
90inherit autotools base 96inherit autotools base eutils libtool
91 97
92EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test 98EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test
93 99
94# @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR 100# @ECLASS-VARIABLE: AUTOTOOLS_BUILD_DIR
95# @DESCRIPTION: 101# @DESCRIPTION:
129 fi 135 fi
130 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\"" 136 echo ">>> Working in BUILD_DIR: \"$AUTOTOOLS_BUILD_DIR\""
131} 137}
132 138
133# @FUNCTION: remove_libtool_files 139# @FUNCTION: remove_libtool_files
134# @USAGE: [all|none] 140# @USAGE: [all]
135# @DESCRIPTION: 141# @DESCRIPTION:
136# Determines unnecessary libtool files (.la) and libtool static archives (.a) 142# Determines unnecessary libtool files (.la) and libtool static archives (.a)
137# and removes them from installation image. 143# and removes them from installation image.
144#
138# To unconditionally remove all libtool files, pass 'all' as argument. 145# To unconditionally remove all libtool files, pass 'all' as argument.
139# To leave all libtool files alone, pass 'none' as argument. 146# Otherwise, libtool archives required for static linking will be preserved.
140# Unnecessary static archives are removed in any case.
141# 147#
142# In most cases it's not necessary to manually invoke this function. 148# In most cases it's not necessary to manually invoke this function.
143# See autotools-utils_src_install for reference. 149# See autotools-utils_src_install for reference.
144remove_libtool_files() { 150remove_libtool_files() {
145 debug-print-function ${FUNCNAME} "$@" 151 debug-print-function ${FUNCNAME} "$@"
152 local removing_all
153 [[ ${#} -le 1 ]] || die "Invalid number of args to ${FUNCNAME}()"
154 if [[ ${#} -eq 1 ]]; then
155 case "${1}" in
156 all)
157 removing_all=1
158 ;;
159 *)
160 die "Invalid argument to ${FUNCNAME}(): ${1}"
161 esac
162 fi
163
164 local pc_libs=()
165 if [[ ! ${removing_all} ]]; then
166 local arg
167 for arg in $(find "${D}" -name '*.pc' -exec \
168 sed -n -e 's;^Libs:;;p' {} +); do
169 [[ ${arg} == -l* ]] && pc_libs+=(lib${arg#-l}.la)
170 done
171 fi
146 172
147 local f 173 local f
148 for f in $(find "${D}" -type f -name '*.la'); do 174 find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do
149 # Keep only .la files with shouldnotlink=yes - likely plugins
150 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}") 175 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
176 local archivefile=${f/%.la/.a}
177 [[ "${f}" != "${archivefile}" ]] || die 'regex sanity check failed'
178
179 # Remove static libs we're not supposed to link against.
151 if [[ "$1" == 'all' || -z ${shouldnotlink} ]]; then 180 if [[ ${shouldnotlink} ]]; then
152 if [[ "$1" != 'none' ]]; then 181 einfo "Removing unnecessary ${archivefile#${D%/}}"
153 echo "Removing unnecessary ${f}" 182 rm -f "${archivefile}" || die
154 rm -f "${f}" 183 # The .la file may be used by a module loader, so avoid removing it
155 fi 184 # unless explicitly requested.
185 [[ ${removing_all} ]] || continue
156 fi 186 fi
157 # Remove static libs we're not supposed to link against 187
158 if [[ -n ${shouldnotlink} ]]; then 188 # Remove .la files when:
159 local remove=${f/%.la/.a} 189 # - user explicitly wants us to remove all .la files,
160 [[ "${f}" != "${remove}" ]] || die 'regex sanity check failed' 190 # - respective static archive doesn't exist,
191 # - they are covered by a .pc file already,
192 # - they don't provide any new information (no libs & no flags).
193 local removing
194 if [[ ${removing_all} ]]; then removing='forced'
195 elif [[ ! -f ${archivefile} ]]; then removing='no static archive'
196 elif has "$(basename "${f}")" "${pc_libs[@]}"; then
197 removing='covered by .pc'
198 elif [[ ! $(sed -n -e \
199 "s/^\(dependency_libs\|inherited_linker_flags\)='\(.*\)'$/\2/p" \
200 "${f}") ]]; then removing='no libs & flags'
201 fi
202
203 if [[ ${removing} ]]; then
161 echo "Removing unnecessary ${remove}" 204 einfo "Removing unnecessary ${f#${D%/}} (${removing})"
162 rm -f "${remove}" 205 rm -f "${f}" || die
163 fi 206 fi
164 done 207 done
165} 208}
166 209
167# @FUNCTION: autotools-utils_src_prepare 210# @FUNCTION: autotools-utils_src_prepare
171# Supporting PATCHES array and user patches. See base.eclass(5) for reference. 214# Supporting PATCHES array and user patches. See base.eclass(5) for reference.
172autotools-utils_src_prepare() { 215autotools-utils_src_prepare() {
173 debug-print-function ${FUNCNAME} "$@" 216 debug-print-function ${FUNCNAME} "$@"
174 217
175 base_src_prepare 218 base_src_prepare
219 elibtoolize --patch-only
176} 220}
177 221
178# @FUNCTION: autotools-utils_src_configure 222# @FUNCTION: autotools-utils_src_configure
179# @DESCRIPTION: 223# @DESCRIPTION:
180# The src_configure function. For out of source build it creates build 224# The src_configure function. For out of source build it creates build
181# directory and runs econf there. Configuration parameters defined 225# directory and runs econf there. Configuration parameters defined
182# in myeconfargs are passed here to econf. Additionally following USE 226# in myeconfargs are passed here to econf. Additionally following USE
183# flags are known: 227# flags are known:
184# 228#
185# IUSE="debug" passes --disable-debug/--enable-debug to econf respectively.
186#
187# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static 229# IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
188# to econf respectively. 230# to econf respectively.
189autotools-utils_src_configure() { 231autotools-utils_src_configure() {
190 debug-print-function ${FUNCNAME} "$@" 232 debug-print-function ${FUNCNAME} "$@"
191 233
234 [[ -z ${myeconfargs+1} || $(declare -p myeconfargs) == 'declare -a'* ]] \
235 || die 'autotools-utils.eclass: myeconfargs has to be an array.'
236
192 # Common args 237 # Common args
193 local econfargs=() 238 local econfargs=()
194 239
195 # Handle debug found in IUSE
196 if has debug ${IUSE//+}; then
197 econfargs+=($(use_enable debug))
198 fi
199
200 # Handle static-libs found in IUSE, disable them by default 240 # Handle static-libs found in IUSE, disable them by default
201 if has static-libs ${IUSE//+}; then 241 if in_iuse static-libs; then
202 econfargs+=( 242 econfargs+=(
203 --enable-shared 243 --enable-shared
204 $(use_enable static-libs static) 244 $(use_enable static-libs static)
205 ) 245 )
206 fi 246 fi
208 # Append user args 248 # Append user args
209 econfargs+=("${myeconfargs[@]}") 249 econfargs+=("${myeconfargs[@]}")
210 250
211 _check_build_dir 251 _check_build_dir
212 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed" 252 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
213 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 253 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
214 base_src_configure "${econfargs[@]}" "$@" 254 base_src_configure "${econfargs[@]}" "$@"
215 popd > /dev/null 255 popd > /dev/null || die
216} 256}
217 257
218# @FUNCTION: autotools-utils_src_compile 258# @FUNCTION: autotools-utils_src_compile
219# @DESCRIPTION: 259# @DESCRIPTION:
220# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR. 260# The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
221autotools-utils_src_compile() { 261autotools-utils_src_compile() {
222 debug-print-function ${FUNCNAME} "$@" 262 debug-print-function ${FUNCNAME} "$@"
223 263
224 _check_build_dir 264 _check_build_dir
225 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 265 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
226 base_src_compile "$@" 266 base_src_compile "$@"
227 popd > /dev/null 267 popd > /dev/null || die
228} 268}
229 269
230# @FUNCTION: autotools-utils_src_install 270# @FUNCTION: autotools-utils_src_install
231# @DESCRIPTION: 271# @DESCRIPTION:
232# The autotools src_install function. Runs emake install, unconditionally 272# The autotools src_install function. Runs emake install, unconditionally
237# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference. 277# DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
238autotools-utils_src_install() { 278autotools-utils_src_install() {
239 debug-print-function ${FUNCNAME} "$@" 279 debug-print-function ${FUNCNAME} "$@"
240 280
241 _check_build_dir 281 _check_build_dir
242 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 282 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
243 base_src_install 283 base_src_install "$@"
244 popd > /dev/null 284 popd > /dev/null || die
245 285
246 # Remove libtool files and unnecessary static libs 286 # Remove libtool files and unnecessary static libs
247 local args
248 has static-libs ${IUSE//+} && ! use static-libs || args='none'
249 remove_libtool_files ${args} 287 remove_libtool_files
250} 288}
251 289
252# @FUNCTION: autotools-utils_src_test 290# @FUNCTION: autotools-utils_src_test
253# @DESCRIPTION: 291# @DESCRIPTION:
254# The autotools src_test function. Runs emake check in build directory. 292# The autotools src_test function. Runs emake check in build directory.
255autotools-utils_src_test() { 293autotools-utils_src_test() {
256 debug-print-function ${FUNCNAME} "$@" 294 debug-print-function ${FUNCNAME} "$@"
257 295
258 _check_build_dir 296 _check_build_dir
259 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null 297 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null || die
260 # Run default src_test as defined in ebuild.sh 298 # Run default src_test as defined in ebuild.sh
261 default_src_test 299 default_src_test
262 popd > /dev/null 300 popd > /dev/null || die
263} 301}

Legend:
Removed from v.1.8  
changed lines
  Added in v.1.28

  ViewVC Help
Powered by ViewVC 1.1.20