1 # Copyright 1999-2019 Gentoo Authors
2 # Distributed under the terms of the GNU General Public License v2
4 # @ECLASS: waf-utils.eclass
6 # maintainer-needed@gentoo.org
8 # Original Author: Gilles Dartiguelongue <eva@gentoo.org>
9 # Various improvements based on cmake-utils.eclass: Tomáš Chvátal <scarabeus@gentoo.org>
10 # Proper prefix support: Jonathan Callen <jcallen@gentoo.org>
11 # @SUPPORTED_EAPIS: 4 5 6
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 [[ ${EAPI} == [45] ]] && inherit eutils
19 inherit multilib toolchain-funcs multiprocessing
22 4|5|6) EXPORT_FUNCTIONS src_configure src_compile src_install ;;
23 *) die "EAPI=${EAPI} is not supported" ;;
26 # @ECLASS-VARIABLE: WAF_VERBOSE
28 # Set to OFF to disable verbose messages during compilation
29 # this is _not_ meant to be set in ebuilds
32 # @FUNCTION: waf-utils_src_configure
34 # General function for configuring with waf.
35 waf-utils_src_configure() {
36 debug-print-function ${FUNCNAME} "$@"
39 if [[ ! ${_PYTHON_ANY_R1} && ! ${_PYTHON_SINGLE_R1} && ! ${_PYTHON_R1} ]]; then
40 eerror "Using waf-utils.eclass without any python-r1 suite eclass is not supported."
41 eerror "Please make sure to configure and inherit appropriate -r1 eclass."
42 eerror "For more information and examples, please see:"
43 eerror " https://wiki.gentoo.org/wiki/Project:Python/waf-utils_integration"
46 if [[ ! ${EPYTHON} ]]; then
47 eerror "EPYTHON is unset while calling waf-utils. This most likely means that"
48 eerror "the ebuild did not call the appropriate eclass function before calling waf."
49 if [[ ${_PYTHON_ANY_R1} ]]; then
50 eerror "Please ensure that python-any-r1_pkg_setup is called in pkg_setup()."
51 elif [[ ${_PYTHON_SINGLE_R1} ]]; then
52 eerror "Please ensure that python-single-r1_pkg_setup is called in pkg_setup()."
54 eerror "Please ensure that python_setup is called before waf-utils_src_configure(),"
55 eerror "or that the latter is used within python_foreach_impl as appropriate."
61 if [[ ${PYTHON_REQ_USE} != *threads* ]]; then
62 eerror "Waf requires threading support in Python. To accomodate this requirement,"
63 eerror "please add 'threads(+)' to PYTHON_REQ_USE variable (above inherit line)."
64 eerror "For more information and examples, please see:"
65 eerror " https://wiki.gentoo.org/wiki/Project:Python/waf-utils_integration"
70 [[ ${fail} ]] && die "Invalid use of waf-utils.eclass"
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} ]] && conf_args+=(--libdir="${EPREFIX}/usr/$(get_libdir)")
86 local waf_help=$("${WAF_BINARY}" --help 2>/dev/null)
87 if [[ ${waf_help} == *--docdir* ]]; then
88 conf_args+=( --docdir="${EPREFIX}"/usr/share/doc/${PF} )
90 if [[ ${waf_help} == *--htmldir* ]]; then
91 conf_args+=( --htmldir="${EPREFIX}"/usr/share/doc/${PF}/html )
94 tc-export AR CC CPP CXX RANLIB
98 LINKFLAGS="${CFLAGS} ${LDFLAGS}"
99 PKGCONFIG="$(tc-getPKG_CONFIG)"
101 "--prefix=${EPREFIX}/usr"
107 echo "${CMD[@]@Q}" >&2
108 env "${CMD[@]}" || die "configure failed"
111 # @FUNCTION: waf-utils_src_compile
113 # General function for compiling with waf.
114 waf-utils_src_compile() {
115 debug-print-function ${FUNCNAME} "$@"
117 [[ ${WAF_VERBOSE} == ON ]] && _mywafconfig="--verbose"
119 local jobs="--jobs=$(makeopts_jobs)"
120 echo "\"${WAF_BINARY}\" build ${_mywafconfig} ${jobs} ${*}"
121 "${WAF_BINARY}" ${_mywafconfig} ${jobs} "${@}" || die "build failed"
124 # @FUNCTION: waf-utils_src_install
126 # Function for installing the package.
127 waf-utils_src_install() {
128 debug-print-function ${FUNCNAME} "$@"
130 echo "\"${WAF_BINARY}\" --destdir=\"${D}\" ${*} install"
131 "${WAF_BINARY}" --destdir="${D}" "${@}" install || die "Make install failed"
133 # Manual document installation