1 # Copyright 1999-2015 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
5 # @ECLASS: waf-utils.eclass
7 # maintainer-needed@gentoo.org
9 # Original Author: Gilles Dartiguelongue <eva@gentoo.org>
10 # Various improvements based on cmake-utils.eclass: Tomáš Chvátal <scarabeus@gentoo.org>
11 # Proper prefix support: Jonathan Callen <jcallen@gentoo.org>
12 # @BLURB: common ebuild functions for waf-based packages
14 # The waf-utils eclass contains functions that make creating ebuild for
15 # waf-based packages much easier.
16 # Its main features are support of common portage default settings.
18 inherit eutils multilib toolchain-funcs multiprocessing
21 4|5|6) EXPORT_FUNCTIONS src_configure src_compile src_install ;;
22 *) die "EAPI=${EAPI} is not supported" ;;
25 # Python with threads is required to run waf. We do not know which python slot
26 # is being used as the system interpreter, so we are forced to block all
27 # slots that have USE=-threads.
30 !dev-lang/python[-threads]"
32 # @ECLASS-VARIABLE: WAF_VERBOSE
34 # Set to OFF to disable verbose messages during compilation
35 # this is _not_ meant to be set in ebuilds
38 # @FUNCTION: waf-utils_src_configure
40 # General function for configuring with waf.
41 waf-utils_src_configure() {
42 debug-print-function ${FUNCNAME} "$@"
44 if [[ ! ${_PYTHON_ANY_R1} && ! ${_PYTHON_SINGLE_R1} && ! ${_PYTHON_R1} ]]; then
45 eqawarn "Using waf-utils.eclass without any python-r1 suite eclass is not supported"
46 eqawarn "and will be banned on 2015-01-24. Please make sure to configure and inherit"
47 eqawarn "appropriate -r1 eclass. For more information and examples, please see:"
48 eqawarn " https://wiki.gentoo.org/wiki/Project:Python/waf-utils_integration"
50 if [[ ! ${EPYTHON} ]]; then
51 eqawarn "EPYTHON is unset while calling waf-utils. This most likely means that"
52 eqawarn "the ebuild did not call the appropriate eclass function before calling waf."
53 if [[ ${_PYTHON_ANY_R1} ]]; then
54 eqawarn "Please ensure that python-any-r1_pkg_setup is called in pkg_setup()."
55 elif [[ ${_PYTHON_SINGLE_R1} ]]; then
56 eqawarn "Please ensure that python-single-r1_pkg_setup is called in pkg_setup()."
58 eqawarn "Please ensure that python_setup is called before waf-utils_src_configure(),"
59 eqawarn "or that the latter is used within python_foreach_impl as appropriate."
64 if [[ ${PYTHON_REQ_USE} != *threads* ]]; then
65 eqawarn "Waf requires threading support in Python. To accomodate this requirement,"
66 eqawarn "please add 'threads(+)' to PYTHON_REQ_USE variable (above inherit line)."
67 eqawarn "For more information and examples, please see:"
68 eqawarn " https://wiki.gentoo.org/wiki/Project:Python/waf-utils_integration"
74 # @ECLASS-VARIABLE: WAF_BINARY
76 # Eclass can use different waf executable. Usually it is located in "${S}/waf".
77 : ${WAF_BINARY:="${S}/waf"}
79 # @ECLASS-VARIABLE: NO_WAF_LIBDIR
82 # Variable specifying that you don't want to set the libdir for waf script.
83 # Some scripts does not allow setting it at all and die if they find it.
84 [[ -z ${NO_WAF_LIBDIR} ]] && libdir="--libdir=${EPREFIX}/usr/$(get_libdir)"
86 tc-export AR CC CPP CXX RANLIB
87 echo "CCFLAGS=\"${CFLAGS}\" LINKFLAGS=\"${CFLAGS} ${LDFLAGS}\" \"${WAF_BINARY}\" --prefix=${EPREFIX}/usr ${libdir} $@ configure"
89 # This condition is required because waf takes even whitespace as function
90 # calls, awesome isn't it?
91 if [[ -z ${NO_WAF_LIBDIR} ]]; then
92 CCFLAGS="${CFLAGS}" LINKFLAGS="${CFLAGS} ${LDFLAGS}" "${WAF_BINARY}" \
93 "--prefix=${EPREFIX}/usr" \
96 configure || die "configure failed"
98 CCFLAGS="${CFLAGS}" LINKFLAGS="${CFLAGS} ${LDFLAGS}" "${WAF_BINARY}" \
99 "--prefix=${EPREFIX}/usr" \
101 configure || die "configure failed"
105 # @FUNCTION: waf-utils_src_compile
107 # General function for compiling with waf.
108 waf-utils_src_compile() {
109 debug-print-function ${FUNCNAME} "$@"
111 [[ "${WAF_VERBOSE}" ]] && _mywafconfig="--verbose"
113 local jobs="--jobs=$(makeopts_jobs)"
114 echo "\"${WAF_BINARY}\" build ${_mywafconfig} ${jobs}"
115 "${WAF_BINARY}" ${_mywafconfig} ${jobs} || die "build failed"
118 # @FUNCTION: waf-utils_src_install
120 # Function for installing the package.
121 waf-utils_src_install() {
122 debug-print-function ${FUNCNAME} "$@"
124 echo "\"${WAF_BINARY}\" --destdir=\"${D}\" install"
125 "${WAF_BINARY}" --destdir="${D}" install || die "Make install failed"
127 # Manual document installation