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

Contents of /eclass/autotools-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.14 - (show annotations) (download)
Fri Sep 16 15:33:19 2011 UTC (3 years, 3 months ago) by mgorny
Branch: MAIN
Changes since 1.13: +14 -13 lines
For .la removal, look for static archives rather than USE=static-libs.

1 # Copyright 1999-2010 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/autotools-utils.eclass,v 1.13 2011/09/16 15:29:22 mgorny Exp $
4
5 # @ECLASS: autotools-utils.eclass
6 # @MAINTAINER:
7 # Maciej Mrozowski <reavertm@gentoo.org>
8 # Michał Górny <mgorny@gentoo.org>
9 # @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 # local myeconfargs=(
61 # $(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 2|3|4) ;;
88 *) die "EAPI=${EAPI} is not supported" ;;
89 esac
90
91 inherit autotools base
92
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 # local myeconfargs=(
114 # --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 # @USAGE: [all]
136 # @DESCRIPTION:
137 # Determines unnecessary libtool files (.la) and libtool static archives (.a)
138 # and removes them from installation image.
139 #
140 # To unconditionally remove all libtool files, pass 'all' as argument.
141 # Otherwise, libtool archives required for static linking will be preserved.
142 #
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
148 local f
149 find "${D}" -type f -name '*.la' -print0 | while read -r -d '' f; do
150 local shouldnotlink=$(sed -ne '/^shouldnotlink=yes$/p' "${f}")
151 local archivefile=${f/%.la/.a}
152
153 # Keep .la files when:
154 # - they have shouldnotlink=yes - likely plugins,
155 # - respective static archive exists.
156 if [[ "$1" == 'all' || ( -z ${shouldnotlink} && ! -f ${archivefile} ) ]]; then
157 einfo "Removing unnecessary ${f#${D%/}}"
158 rm -f "${f}"
159 fi
160
161 # Remove static libs we're not supposed to link against
162 if [[ -n ${shouldnotlink} ]]; then
163 local remove=${f/%.la/.a}
164 [[ "${f}" != "${remove}" ]] || die 'regex sanity check failed'
165 einfo "Removing unnecessary ${remove#${D%/}}"
166 rm -f "${remove}"
167 fi
168 done
169 }
170
171 # @FUNCTION: autotools-utils_src_prepare
172 # @DESCRIPTION:
173 # The src_prepare function.
174 #
175 # Supporting PATCHES array and user patches. See base.eclass(5) for reference.
176 autotools-utils_src_prepare() {
177 debug-print-function ${FUNCNAME} "$@"
178
179 base_src_prepare
180 }
181
182 # @FUNCTION: autotools-utils_src_configure
183 # @DESCRIPTION:
184 # The src_configure function. For out of source build it creates build
185 # directory and runs econf there. Configuration parameters defined
186 # in myeconfargs are passed here to econf. Additionally following USE
187 # flags are known:
188 #
189 # IUSE="debug" passes --disable-debug/--enable-debug to econf respectively.
190 #
191 # IUSE="static-libs" passes --enable-shared and either --disable-static/--enable-static
192 # to econf respectively.
193 autotools-utils_src_configure() {
194 debug-print-function ${FUNCNAME} "$@"
195
196 # Common args
197 local econfargs=()
198
199 # Handle debug found in IUSE
200 if has debug ${IUSE//+}; then
201 econfargs+=($(use_enable debug))
202 fi
203
204 # Handle static-libs found in IUSE, disable them by default
205 if has static-libs ${IUSE//+}; then
206 econfargs+=(
207 --enable-shared
208 $(use_enable static-libs static)
209 )
210 fi
211
212 # Append user args
213 econfargs+=("${myeconfargs[@]}")
214
215 _check_build_dir
216 mkdir -p "${AUTOTOOLS_BUILD_DIR}" || die "mkdir '${AUTOTOOLS_BUILD_DIR}' failed"
217 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
218 base_src_configure "${econfargs[@]}" "$@"
219 popd > /dev/null
220 }
221
222 # @FUNCTION: autotools-utils_src_compile
223 # @DESCRIPTION:
224 # The autotools src_compile function, invokes emake in specified AUTOTOOLS_BUILD_DIR.
225 autotools-utils_src_compile() {
226 debug-print-function ${FUNCNAME} "$@"
227
228 _check_build_dir
229 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
230 base_src_compile "$@"
231 popd > /dev/null
232 }
233
234 # @FUNCTION: autotools-utils_src_install
235 # @DESCRIPTION:
236 # The autotools src_install function. Runs emake install, unconditionally
237 # removes unnecessary static libs (based on shouldnotlink libtool property)
238 # and removes unnecessary libtool files when static-libs USE flag is defined
239 # and unset.
240 #
241 # DOCS and HTML_DOCS arrays are supported. See base.eclass(5) for reference.
242 autotools-utils_src_install() {
243 debug-print-function ${FUNCNAME} "$@"
244
245 _check_build_dir
246 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
247 base_src_install "$@"
248 popd > /dev/null
249
250 # Remove libtool files and unnecessary static libs
251 remove_libtool_files
252 }
253
254 # @FUNCTION: autotools-utils_src_test
255 # @DESCRIPTION:
256 # The autotools src_test function. Runs emake check in build directory.
257 autotools-utils_src_test() {
258 debug-print-function ${FUNCNAME} "$@"
259
260 _check_build_dir
261 pushd "${AUTOTOOLS_BUILD_DIR}" > /dev/null
262 # Run default src_test as defined in ebuild.sh
263 default_src_test
264 popd > /dev/null
265 }

  ViewVC Help
Powered by ViewVC 1.1.20