-# Copyright 1999-2015 Gentoo Foundation
+# Copyright 1999-2020 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
-# $Id$
# @ECLASS: scons-utils.eclass
# @MAINTAINER:
# mgorny@gentoo.org
+# @SUPPORTED_EAPIS: 0 1 2 3 4 5 6 7
# @BLURB: helper functions to deal with SCons buildsystem
# @DESCRIPTION:
# This eclass provides a set of function to help developers sanely call
# dev-util/scons and pass parameters to it.
#
+# As of dev-util/scons-3.0.1-r100, SCons supports Python 3. Since
+# SCons* files in build systems are written as Python, all packages
+# need to explicitly verify which versions of Python are supported
+# and use appropriate Python suite eclass to select the implementation.
+# The eclass needs to be inherited before scons-utils, and scons-utils
+# will automatically take advantage of it. For more details, please see:
+# https://wiki.gentoo.org/wiki/Project:Python/scons-utils_integration
+#
# Please note that SCons is more like a 'build system creation kit',
# and requires a lot of upstream customization to be used sanely.
# You will often need to request fixes upstream and/or patch the build
#
# @EXAMPLE:
# @CODE
-# inherit scons-utils toolchain-funcs
+# PYTHON_COMPAT=( python2_7 )
+# inherit python-any-r1 scons-utils toolchain-funcs
#
# EAPI=5
#
# @ECLASS-VARIABLE: USE_SCONS_TRUE
# @DESCRIPTION:
+# DEPRECATED: use usex instead
+#
# The default value for truth in scons-use() (1 by default).
: ${USE_SCONS_TRUE:=1}
# @ECLASS-VARIABLE: USE_SCONS_FALSE
# @DESCRIPTION:
+# DEPRECATED: use usex instead
+#
# The default value for false in scons-use() (0 by default).
: ${USE_SCONS_FALSE:=0}
# -- EAPI support check --
case ${EAPI:-0} in
- 0|1|2|3|4|5) ;;
+ 0|1|2|3|4|5|6|7) ;;
*) die "EAPI ${EAPI} unsupported."
esac
+inherit multiprocessing
+
# -- ebuild variables setup --
if [[ -n ${SCONS_MIN_VERSION} ]]; then
- DEPEND=">=dev-util/scons-${SCONS_MIN_VERSION}"
+ SCONS_DEPEND=">=dev-util/scons-${SCONS_MIN_VERSION}"
else
- DEPEND="dev-util/scons"
+ SCONS_DEPEND="dev-util/scons"
+fi
+
+if [[ ${_PYTHON_ANY_R1} ]]; then
+ # when using python-any-r1, use any-of dep API
+ BDEPEND="$(python_gen_any_dep "${SCONS_DEPEND}[\${PYTHON_USEDEP}]")"
+
+ scons-utils_python_check_deps() {
+ has_version "${SCONS_DEPEND}[${PYTHON_USEDEP}]"
+ }
+ python_check_deps() { scons-utils_python_check_deps; }
+elif [[ ${_PYTHON_SINGLE_R1} ]]; then
+ # when using python-single-r1, use PYTHON_MULTI_USEDEP API
+ BDEPEND="
+ $(python_gen_cond_dep "${SCONS_DEPEND}[\${PYTHON_MULTI_USEDEP}]")
+ ${PYTHON_DEPS}"
+elif [[ ${EAPI:-0} == [0123456] ]]; then
+ # in older EAPIs, just force Python 2.7
+ BDEPEND="${SCONS_DEPEND}[python_targets_python2_7]"
+elif [[ ${_PYTHON_R1} ]]; then
+ # when using python-r1, you need to depend on scons yourself
+ # (depending on whether you need any-r1 or full -r1 API)
+ # -- since this is a breaking API change, it applies to EAPI 7+ only
+ BDEPEND=""
+elif [[ ${EAPI:-0} != [0123456] ]]; then
+ # in EAPI 7+, require appropriate eclass use
+ eerror "Using scons-utils.eclass without any python-r1 suite eclass is not supported."
+ eerror "Please make sure to configure and inherit appropriate -r1 eclass."
+ eerror "For more information and examples, please see:"
+ eerror " https://wiki.gentoo.org/wiki/Project:Python/scons-utils_integration"
+ die "Invalid use of scons-utils.eclass"
+fi
+
+if [[ ${EAPI:-0} == [0123456] ]]; then
+ DEPEND=${BDEPEND}
+ unset BDEPEND
fi
# -- public functions --
debug-print-function ${FUNCNAME} "${@}"
+ if [[ ! ${EPYTHON} ]]; then
+ if [[ ${EAPI:-0} != [0123456] ]]; then
+ eerror "EPYTHON is unset while calling escons. This most likely means that"
+ eerror "the ebuild did not call the appropriate eclass function before calling scons."
+ if [[ ${_PYTHON_ANY_R1} ]]; then
+ eerror "Please ensure that python-any-r1_pkg_setup is called in pkg_setup()."
+ elif [[ ${_PYTHON_SINGLE_R1} ]]; then
+ eerror "Please ensure that python-single-r1_pkg_setup is called in pkg_setup()."
+ else # python-r1
+ eerror "Please ensure that python_setup is called before escons, or that escons"
+ eerror "is used within python_foreach_impl as appropriate."
+ fi
+ die "EPYTHON unset in escons"
+ else
+ local -x EPYTHON=python2.7
+ fi
+ fi
+
# Use myesconsargs in EAPI 5 and older
if [[ ${EAPI} == [012345] ]]; then
set -- "${myesconsargs[@]}" "${@}"
fi
# if SCONSOPTS are _unset_, use cleaned MAKEOPTS
- set -- scons ${SCONSOPTS-$(scons_clean_makeopts)} ${EXTRA_ESCONS} \
- "${@}"
+ if [[ ! ${SCONSOPTS+set} ]]; then
+ local SCONSOPTS
+ _scons_clean_makeopts
+ fi
+
+ # pass ebuild environment variables through!
+ local -x GENTOO_SCONS_ENV_PASSTHROUGH=1
+
+ set -- scons ${SCONSOPTS} ${EXTRA_ESCONS} "${@}"
echo "${@}" >&2
"${@}"
ret=${?}
return ${ret}
}
-# @FUNCTION: scons_clean_makeopts
+# @FUNCTION: _scons_clean_makeopts
+# @INTERNAL
# @USAGE: [makeflags] [...]
# @DESCRIPTION:
# Strip the supplied makeflags (or ${MAKEOPTS} if called without
# an argument) of options not supported by SCons and make sure --jobs
# gets an argument. Output the resulting flag list (suitable
# for an assignment to SCONSOPTS).
-scons_clean_makeopts() {
- local new_makeopts
+_scons_clean_makeopts() {
+ local new_makeopts=()
debug-print-function ${FUNCNAME} "${@}"
# empty MAKEOPTS give out empty SCONSOPTS
# thus, we do need to worry about the initial setup
if [[ ${*} = ${_SCONS_CACHE_MAKEOPTS} ]]; then
- set -- ${_SCONS_CACHE_SCONSOPTS}
- debug-print "Cache hit: [${*}]"
- echo ${*}
+ SCONSOPTS=${_SCONS_CACHE_SCONSOPTS}
+ debug-print "Cache hit: [${SCONSOPTS}]"
return
fi
- export _SCONS_CACHE_MAKEOPTS=${*}
+ _SCONS_CACHE_MAKEOPTS=${*}
while [[ ${#} -gt 0 ]]; do
case ${1} in
# clean, simple to check -- we like that
--jobs=*|--keep-going)
- new_makeopts=${new_makeopts+${new_makeopts} }${1}
+ new_makeopts+=( ${1} )
;;
# need to take a look at the next arg and guess
--jobs)
if [[ ${#} -gt 1 && ${2} =~ ^[0-9]+$ ]]; then
- new_makeopts="${new_makeopts+${new_makeopts} }${1} ${2}"
+ new_makeopts+=( ${1} ${2} )
shift
else
- # no value means no limit, let's pass a random int
- new_makeopts=${new_makeopts+${new_makeopts} }${1}=5
+ # no value means no limit, let's pass a default instead
+ new_makeopts+=( ${1}=$(( $(get_nproc) + 1 )) )
fi
;;
# strip other long options
while [[ -n ${str} ]]; do
case ${str} in
k*)
- new_optstr=${new_optstr}k
+ new_optstr+=k
;;
# -j needs to come last
j)
if [[ ${#} -gt 1 && ${2} =~ ^[0-9]+$ ]]; then
- new_optstr="${new_optstr}j ${2}"
+ new_optstr+="j ${2}"
shift
else
- new_optstr="${new_optstr}j 5"
+ new_optstr+="j $(( $(get_nproc) + 1 ))"
fi
;;
# otherwise, everything after -j is treated as an arg
j*)
- new_optstr=${new_optstr}${str}
+ new_optstr+=${str}
break
;;
esac
done
if [[ -n ${new_optstr} ]]; then
- new_makeopts=${new_makeopts+${new_makeopts} }-${new_optstr}
+ new_makeopts+=( -${new_optstr} )
fi
;;
esac
shift
done
- set -- ${new_makeopts}
- export _SCONS_CACHE_SCONSOPTS=${*}
- debug-print "New SCONSOPTS: [${*}]"
- echo ${*}
+ SCONSOPTS=${new_makeopts[*]}
+ _SCONS_CACHE_SCONSOPTS=${SCONSOPTS}
+ debug-print "New SCONSOPTS: [${SCONSOPTS}]"
}
# @FUNCTION: use_scons
# @USAGE: <use-flag> [var-name] [var-opt-true] [var-opt-false]
# @DESCRIPTION:
+# DEPRECATED, EAPI 0..5 ONLY: use usex instead
+#
# Output a SCons parameter with value depending on the USE flag state.
# If the USE flag is set, output <var-name>=<var-opt-true>; otherwise
# <var-name>=<var-opt-false>.
# If <var-opt-true> and/or <var-opt-false> are omitted,
# ${USE_SCONS_TRUE} and/or ${USE_SCONS_FALSE} will be used instead.
use_scons() {
+ [[ ${EAPI} == [012345] ]] \
+ || die "${FUNCNAME} is banned in EAPI ${EAPI}, use usex instead"
+
local flag=${1}
local varname=${2:-${flag/\!/no}}
local vartrue=${3:-${USE_SCONS_TRUE}}
projects / gentoo.git / blobdiff