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

Contents of /eclass/autotools-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.15 - (hide annotations) (download)
Fri Sep 16 15:37:41 2011 UTC (2 years, 11 months ago) by mgorny
Branch: MAIN
Changes since 1.14: +6 -7 lines
Clean up & simplify la removal code a little.

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

  ViewVC Help
Powered by ViewVC 1.1.20