eclass/waf-utils.eclass

   1 # Copyright 1999-2019 Gentoo Authors
   2 # Distributed under the terms of the GNU General Public License v2
   3
   4 # @ECLASS: waf-utils.eclass
   5 # @MAINTAINER:
   6 # maintainer-needed@gentoo.org
   7 # @AUTHOR:
   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
  13 # @DESCRIPTION:
  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.
  17
  18 [[ ${EAPI} == [45] ]] && inherit eutils
  19 inherit multilib toolchain-funcs multiprocessing
  20
  21 case ${EAPI:-0} in
  22         4|5|6) EXPORT_FUNCTIONS src_configure src_compile src_install ;;
  23         *) die "EAPI=${EAPI} is not supported" ;;
  24 esac
  25
  26 # @ECLASS-VARIABLE: WAF_VERBOSE
  27 # @DESCRIPTION:
  28 # Set to OFF to disable verbose messages during compilation
  29 # this is _not_ meant to be set in ebuilds
  30 : ${WAF_VERBOSE:=ON}
  31
  32 # @FUNCTION: waf-utils_src_configure
  33 # @DESCRIPTION:
  34 # General function for configuring with waf.
  35 waf-utils_src_configure() {
  36         debug-print-function ${FUNCNAME} "$@"
  37
  38         local fail
  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"
  44                 fail=1
  45         else
  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()."
  53                         else # python-r1
  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."
  56                         fi
  57                         eerror
  58                         fail=1
  59                 fi
  60
  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"
  66                         fail=1
  67                 fi
  68         fi
  69
  70         [[ ${fail} ]] && die "Invalid use of waf-utils.eclass"
  71
  72         # @ECLASS-VARIABLE: WAF_BINARY
  73         # @DESCRIPTION:
  74         # Eclass can use different waf executable. Usually it is located in "${S}/waf".
  75         : ${WAF_BINARY:="${S}/waf"}
  76
  77         local conf_args=()
  78
  79         local waf_help=$("${WAF_BINARY}" --help 2>/dev/null)
  80         if [[ ${waf_help} == *--docdir* ]]; then
  81                 conf_args+=( --docdir="${EPREFIX}"/usr/share/doc/${PF} )
  82         fi
  83         if [[ ${waf_help} == *--htmldir* ]]; then
  84                 conf_args+=( --htmldir="${EPREFIX}"/usr/share/doc/${PF}/html )
  85         fi
  86         if [[ ${waf_help} == *--libdir* ]]; then
  87                 conf_args+=( --libdir="${EPREFIX}/usr/$(get_libdir)" )
  88         fi
  89
  90         tc-export AR CC CPP CXX RANLIB
  91
  92         local CMD=(
  93                 CCFLAGS="${CFLAGS}"
  94                 LINKFLAGS="${CFLAGS} ${LDFLAGS}"
  95                 PKGCONFIG="$(tc-getPKG_CONFIG)"
  96                 "${WAF_BINARY}"
  97                 "--prefix=${EPREFIX}/usr"
  98                 "${conf_args[@]}"
  99                 "${@}"
 100                 configure
 101         )
 102
 103         echo "${CMD[@]@Q}" >&2
 104         env "${CMD[@]}" || die "configure failed"
 105 }
 106
 107 # @FUNCTION: waf-utils_src_compile
 108 # @DESCRIPTION:
 109 # General function for compiling with waf.
 110 waf-utils_src_compile() {
 111         debug-print-function ${FUNCNAME} "$@"
 112         local _mywafconfig
 113         [[ ${WAF_VERBOSE} == ON ]] && _mywafconfig="--verbose"
 114
 115         local jobs="--jobs=$(makeopts_jobs)"
 116         echo "\"${WAF_BINARY}\" build ${_mywafconfig} ${jobs} ${*}"
 117         "${WAF_BINARY}" ${_mywafconfig} ${jobs} "${@}" || die "build failed"
 118 }
 119
 120 # @FUNCTION: waf-utils_src_install
 121 # @DESCRIPTION:
 122 # Function for installing the package.
 123 waf-utils_src_install() {
 124         debug-print-function ${FUNCNAME} "$@"
 125
 126         echo "\"${WAF_BINARY}\" --destdir=\"${D}\" ${*} install"
 127         "${WAF_BINARY}" --destdir="${D}" "${@}" install  || die "Make install failed"
 128
 129         # Manual document installation
 130         einstalldocs
 131 }