eclass/waf-utils.eclass

   1 # Copyright 1999-2015 Gentoo Foundation
   2 # Distributed under the terms of the GNU General Public License v2
   3 # $Id$
   4
   5 # @ECLASS: waf-utils.eclass
   6 # @MAINTAINER:
   7 # maintainer-needed@gentoo.org
   8 # @AUTHOR:
   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
  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         local libdir=()
  73
  74         # @ECLASS-VARIABLE: WAF_BINARY
  75         # @DESCRIPTION:
  76         # Eclass can use different waf executable. Usually it is located in "${S}/waf".
  77         : ${WAF_BINARY:="${S}/waf"}
  78
  79         # @ECLASS-VARIABLE: NO_WAF_LIBDIR
  80         # @DEFAULT_UNSET
  81         # @DESCRIPTION:
  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)")
  85
  86         tc-export AR CC CPP CXX RANLIB
  87         echo "CCFLAGS=\"${CFLAGS}\" LINKFLAGS=\"${CFLAGS} ${LDFLAGS}\" \"${WAF_BINARY}\" --prefix=${EPREFIX}/usr ${libdir[@]} $@ configure"
  88
  89         CCFLAGS="${CFLAGS}" LINKFLAGS="${CFLAGS} ${LDFLAGS}" "${WAF_BINARY}" \
  90                 "--prefix=${EPREFIX}/usr" \
  91                 "${libdir[@]}" \
  92                 "$@" \
  93                 configure || die "configure failed"
  94 }
  95
  96 # @FUNCTION: waf-utils_src_compile
  97 # @DESCRIPTION:
  98 # General function for compiling with waf.
  99 waf-utils_src_compile() {
 100         debug-print-function ${FUNCNAME} "$@"
 101         local _mywafconfig
 102         [[ "${WAF_VERBOSE}" ]] && _mywafconfig="--verbose"
 103
 104         local jobs="--jobs=$(makeopts_jobs)"
 105         echo "\"${WAF_BINARY}\" build ${_mywafconfig} ${jobs}"
 106         "${WAF_BINARY}" ${_mywafconfig} ${jobs} || die "build failed"
 107 }
 108
 109 # @FUNCTION: waf-utils_src_install
 110 # @DESCRIPTION:
 111 # Function for installing the package.
 112 waf-utils_src_install() {
 113         debug-print-function ${FUNCNAME} "$@"
 114
 115         echo "\"${WAF_BINARY}\" --destdir=\"${D}\" install"
 116         "${WAF_BINARY}" --destdir="${D}" install  || die "Make install failed"
 117
 118         # Manual document installation
 119         einstalldocs
 120 }