lua.eclass: split some stuff out as lua-utils.eclass

These are the things that will be used by both lua and lua-single.

Signed-off-by: Marek Szuba <marecki@gentoo.org>

1 files changed, 6 insertions, 339 deletions

diff --git a/eclass/lua.eclass b/eclass/lua.eclass
index 7dccba6980a0..f4594872e58c 100644
--- a/eclass/lua.eclass
+++ b/eclass/lua.eclass
@@ -7,7 +7,7 @@
 # Marek Szuba <marecki@gentoo.org>
 # @AUTHOR:
 # Marek Szuba <marecki@gentoo.org>
-# Based on python{,-utils}-r1.eclass by Michał Górny <mgorny@gentoo.org> et al.
+# Based on python-r1.eclass by Michał Górny <mgorny@gentoo.org> et al.
 # @SUPPORTED_EAPIS: 7
 # @BLURB: A common eclass for Lua packages
 # @DESCRIPTION:
@@ -21,7 +21,9 @@
 # package easily. It also provides methods to easily run a command for
 # each enabled Lua implementation and duplicate the sources for them.
 #
-# Please note that for the time being this eclass does NOT support luajit.
+# Note that since this eclass always inherits lua-utils as well, in ebuilds
+# using the former there is no need to explicitly inherit the latter in order
+# to use helper functions such as lua_get_CFLAGS.
 #
 # @EXAMPLE:
 # @CODE
@@ -61,7 +63,7 @@ esac
 
 if [[ ! ${_LUA_R0} ]]; then
 
-inherit multibuild toolchain-funcs
+inherit multibuild lua-utils
 
 fi
 
@@ -140,28 +142,6 @@ fi
 # ${WORKDIR}/foo-1.3-lua5-1
 # @CODE
 
-# @ECLASS-VARIABLE: ELUA
-# @DEFAULT_UNSET
-# @DESCRIPTION:
-# The executable name of the current Lua interpreter. This variable is set
-# automatically in functions called by lua_foreach_impl().
-#
-# Example value:
-# @CODE
-# lua5.1
-# @CODE
-
-# @ECLASS-VARIABLE: LUA
-# @DEFAULT_UNSET
-# @DESCRIPTION:
-# The absolute path to the current Lua interpreter. This variable is set
-# automatically in functions called by lua_foreach_impl().
-#
-# Example value:
-# @CODE
-# /usr/bin/lua5.1
-# @CODE
-
 # @ECLASS-VARIABLE: LUA_DEPS
 # @OUTPUT_VARIABLE
 # @DESCRIPTION:
@@ -219,112 +199,6 @@ fi
 
 if [[ ! ${_LUA_R0} ]]; then
 
-# @FUNCTION: _lua_export
-# @USAGE: [<impl>] <variables>...
-# @INTERNAL
-# @DESCRIPTION:
-# Set and export the Lua implementation-relevant variables passed
-# as parameters.
-#
-# The optional first parameter may specify the requested Lua
-# implementation (either as LUA_TARGETS value, e.g. lua5-2,
-# or an ELUA one, e.g. lua5.2). If no implementation passed,
-# the current one will be obtained from ${ELUA}.
-_lua_export() {
-	debug-print-function ${FUNCNAME} "${@}"
-
-	local impl var
-
-	case "${1}" in
-		lua*)
-			impl=${1/-/.}
-			shift
-			;;
-		*)
-			impl=${ELUA}
-			if [[ -z ${impl} ]]; then
-				die "_lua_export called without a Lua implementation and ELUA is unset"
-			fi
-			;;
-	esac
-	debug-print "${FUNCNAME}: implementation: ${impl}"
-
-	for var; do
-		case "${var}" in
-			ELUA)
-				export ELUA=${impl}
-				debug-print "${FUNCNAME}: ELUA = ${ELUA}"
-				;;
-			LUA)
-				export LUA="${EPREFIX}"/usr/bin/${impl}
-				debug-print "${FUNCNAME}: LUA = ${LUA}"
-				;;
-			LUA_CFLAGS)
-				local val
-
-				val=$($(tc-getPKG_CONFIG) --cflags ${impl}) || die
-
-				export LUA_CFLAGS=${val}
-				debug-print "${FUNCNAME}: LUA_CFLAGS = ${LUA_CFLAGS}"
-				;;
-			LUA_CMOD_DIR)
-				local val
-
-				val=$($(tc-getPKG_CONFIG) --variable INSTALL_CMOD ${impl}) || die
-
-				export LUA_CMOD_DIR=${val}
-				debug-print "${FUNCNAME}: LUA_CMOD_DIR = ${LUA_CMOD_DIR}"
-				;;
-			LUA_LIBS)
-				local val
-
-				val=$($(tc-getPKG_CONFIG) --libs ${impl}) || die
-
-				export LUA_LIBS=${val}
-				debug-print "${FUNCNAME}: LUA_LIBS = ${LUA_LIBS}"
-				;;
-			LUA_LMOD_DIR)
-				local val
-
-				val=$($(tc-getPKG_CONFIG) --variable INSTALL_LMOD ${impl}) || die
-
-				export LUA_LMOD_DIR=${val}
-				debug-print "${FUNCNAME}: LUA_LMOD_DIR = ${LUA_LMOD_DIR}"
-				;;
-			LUA_PKG_DEP)
-				local d
-				case ${impl} in
-					lua*)
-						LUA_PKG_DEP="dev-lang/lua:${impl#lua}"
-						;;
-					*)
-						die "Invalid implementation: ${impl}"
-						;;
-				esac
-
-				# use-dep
-				if [[ ${LUA_REQ_USE} ]]; then
-					LUA_PKG_DEP+=[${LUA_REQ_USE}]
-				fi
-
-				export LUA_PKG_DEP
-				debug-print "${FUNCNAME}: LUA_PKG_DEP = ${LUA_PKG_DEP}"
-				;;
-			LUA_VERSION)
-				local val
-
-				val=$($(tc-getPKG_CONFIG) --modversion ${impl}) || die
-
-				export LUA_VERSION=${val}
-				debug-print "${FUNCNAME}: LUA_VERSION = ${LUA_VERSION}"
-				;;
-			*)
-				die "_lua_export: unknown variable ${var}"
-				;;
-		esac
-	done
-}
-
 # @FUNCTION: _lua_validate_useflags
 # @INTERNAL
 # @DESCRIPTION:
@@ -401,61 +275,6 @@ _lua_multibuild_wrapper() {
 	"${@}"
 }
 
-# @FUNCTION: _lua_wrapper_setup
-# @USAGE: [<path> [<impl>]]
-# @INTERNAL
-# @DESCRIPTION:
-# Create proper Lua executables and pkg-config wrappers
-# (if available) in the directory named by <path>. Set up PATH
-# and PKG_CONFIG_PATH appropriately. <path> defaults to ${T}/${ELUA}.
-#
-# The wrappers will be created for implementation named by <impl>,
-# or for one named by ${ELUA} if no <impl> passed.
-#
-# If the named directory contains a lua symlink already, it will
-# be assumed to contain proper wrappers already and only environment
-# setup will be done. If wrapper update is requested, the directory
-# shall be removed first.
-_lua_wrapper_setup() {
-	debug-print-function ${FUNCNAME} "${@}"
-
-	local workdir=${1:-${T}/${ELUA}}
-	local impl=${2:-${ELUA}}
-
-	[[ ${workdir} ]] || die "${FUNCNAME}: no workdir specified."
-	[[ ${impl} ]] || die "${FUNCNAME}: no impl nor ELUA specified."
-
-	if [[ ! -x ${workdir}/bin/lua ]]; then
-		mkdir -p "${workdir}"/{bin,pkgconfig} || die
-
-		# Clean up, in case we were supposed to do a cheap update
-		rm -f "${workdir}"/bin/lua{,c} || die
-		rm -f "${workdir}"/pkgconfig/lua.pc || die
-
-		local ELUA LUA
-		_lua_export "${impl}" ELUA LUA
-
-		# Lua interpreter and compiler
-		ln -s "${EPREFIX}"/usr/bin/${ELUA} "${workdir}"/bin/lua || die
-		ln -s "${EPREFIX}"/usr/bin/${ELUA/a/ac} "${workdir}"/bin/luac || die
-
-		# pkg-config
-		ln -s "${EPREFIX}"/usr/$(get_libdir)/pkgconfig/${ELUA}.pc \
-			"${workdir}"/pkgconfig/lua.pc || die
-	fi
-
-	# Now, set the environment.
-	# But note that ${workdir} may be shared with something else,
-	# and thus already on top of PATH.
-	if [[ ${PATH##:*} != ${workdir}/bin ]]; then
-		PATH=${workdir}/bin${PATH:+:${PATH}}
-	fi
-	if [[ ${PKG_CONFIG_PATH##:*} != ${workdir}/pkgconfig ]]; then
-		PKG_CONFIG_PATH=${workdir}/pkgconfig${PKG_CONFIG_PATH:+:${PKG_CONFIG_PATH}}
-	fi
-	export PATH PKG_CONFIG_PATH
-}
-
 # @FUNCTION: lua_copy_sources
 # @DESCRIPTION:
 # Create a single copy of the package sources for each enabled Lua
@@ -495,161 +314,9 @@ lua_foreach_impl() {
 	multibuild_foreach_variant _lua_multibuild_wrapper "${@}"
 }
 
-# @FUNCTION: lua_get_CFLAGS
-# @USAGE: [<impl>]
-# @DESCRIPTION:
-# Obtain and print the compiler flags for building against Lua,
-# for the given implementation. If no implementation is provided,
-# ${ELUA} will be used.
-#
-# Please note that this function requires Lua and pkg-config installed,
-# and therefore proper build-time dependencies need be added to the ebuild.
-lua_get_CFLAGS() {
-	debug-print-function ${FUNCNAME} "${@}"
-
-	_lua_export "${@}" LUA_CFLAGS
-	echo "${LUA_CFLAGS}"
-}
-
-# @FUNCTION: lua_get_cmod_dir
-# @USAGE: [<impl>]
-# @DESCRIPTION:
-# Obtain and print the name of the directory into which compiled Lua
-# modules are installed, for the given implementation. If no implementation
-# is provided, ${ELUA} will be used.
-#
-# Please note that this function requires Lua and pkg-config installed,
-# and therefore proper build-time dependencies need be added to the ebuild.
-lua_get_cmod_dir() {
-	debug-print-function ${FUNCNAME} "${@}"
-
-	_lua_export "${@}" LUA_CMOD_DIR
-	echo "${LUA_CMOD_DIR}"
-}
-
-# @FUNCTION: lua_get_LIBS
-# @USAGE: [<impl>]
-# @DESCRIPTION:
-# Obtain and print the compiler flags for linking against Lua,
-# for the given implementation. If no implementation is provided,
-# ${ELUA} will be used.
-#
-# Please note that this function requires Lua and pkg-config installed,
-# and therefore proper build-time dependencies need be added to the ebuild.
-lua_get_LIBS() {
-	debug-print-function ${FUNCNAME} "${@}"
-
-	_lua_export "${@}" LUA_LIBS
-	echo "${LUA_LIBS}"
-}
-
-# @FUNCTION: lua_get_lmod_dir
-# @USAGE: [<impl>]
-# @DESCRIPTION:
-# Obtain and print the name of the directory into which native-Lua
-# modules are installed, for the given implementation. If no implementation
-# is provided, ${ELUA} will be used.
-#
-# Please note that this function requires Lua and pkg-config installed,
-# and therefore proper build-time dependencies need be added to the ebuild.
-lua_get_lmod_dir() {
-	debug-print-function ${FUNCNAME} "${@}"
-
-	_lua_export "${@}" LUA_LMOD_DIR
-	echo "${LUA_LMOD_DIR}"
-}
-
-# @FUNCTION: lua_get_version
-# @USAGE: [<impl>]
-# @DESCRIPTION:
-# Obtain and print the full version number of the given Lua implementation.
-# If no implementation is provided, ${ELUA} will be used.
-#
-# Please note that this function requires Lua and pkg-config installed,
-# and therefore proper build-time dependencies need be added to the ebuild.
-lua_get_version() {
-	debug-print-function ${FUNCNAME} "${@}"
-
-	_lua_export "${@}" LUA_VERSION
-	echo "${LUA_VERSION}"
-}
-
 _LUA_R0=1
 fi
 
-# @ECLASS-VARIABLE: _LUA_ALL_IMPLS
-# @INTERNAL
-# @DESCRIPTION:
-# All supported Lua implementations, most preferred last
-_LUA_ALL_IMPLS=(
-	lua5-1
-	lua5-2
-	lua5-3
-	lua5-4
-)
-readonly _LUA_ALL_IMPLS
-
-# @FUNCTION: _lua_set_impls
-# @INTERNAL
-# @DESCRIPTION:
-# Check LUA_COMPAT for well-formedness and validity, then set
-# two global variables:
-#
-# - _LUA_SUPPORTED_IMPLS containing valid implementations supported
-#   by the ebuild (LUA_COMPAT minus dead implementations),
-#
-# - and _LUA_UNSUPPORTED_IMPLS containing valid implementations that
-#   are not supported by the ebuild.
-#
-# Implementations in both variables are ordered using the pre-defined
-# eclass implementation ordering.
-#
-# This function must only be called once.
-_lua_set_impls() {
-	local i
-
-	if ! declare -p LUA_COMPAT &>/dev/null; then
-		die 'LUA_COMPAT not declared.'
-	fi
-	if [[ $(declare -p LUA_COMPAT) != "declare -a"* ]]; then
-		die 'LUA_COMPAT must be an array.'
-	fi
-
-	local supp=() unsupp=()
-
-	for i in "${_LUA_ALL_IMPLS[@]}"; do
-		if has "${i}" "${LUA_COMPAT[@]}"; then
-			supp+=( "${i}" )
-		else
-			unsupp+=( "${i}" )
-		fi
-	done
-
-	if [[ ! ${supp[@]} ]]; then
-		die "No supported implementation in LUA_COMPAT."
-	fi
-
-	if [[ ${_LUA_SUPPORTED_IMPLS[@]} ]]; then
-		# set once already, verify integrity
-		if [[ ${_LUA_SUPPORTED_IMPLS[@]} != ${supp[@]} ]]; then
-			eerror "Supported impls (LUA_COMPAT) changed between inherits!"
-			eerror "Before: ${_LUA_SUPPORTED_IMPLS[*]}"
-			eerror "Now   : ${supp[*]}"
-			die "_LUA_SUPPORTED_IMPLS integrity check failed"
-		fi
-		if [[ ${_LUA_UNSUPPORTED_IMPLS[@]} != ${unsupp[@]} ]]; then
-			eerror "Unsupported impls changed between inherits!"
-			eerror "Before: ${_LUA_UNSUPPORTED_IMPLS[*]}"
-			eerror "Now   : ${unsupp[*]}"
-			die "_LUA_UNSUPPORTED_IMPLS integrity check failed"
-		fi
-	else
-		_LUA_SUPPORTED_IMPLS=( "${supp[@]}" )
-		_LUA_UNSUPPORTED_IMPLS=( "${unsupp[@]}" )
-		readonly _LUA_SUPPORTED_IMPLS _LUA_UNSUPPORTED_IMPLS
-	fi
-}
-
 # @FUNCTION: _lua_set_globals
 # @INTERNAL
 # @DESCRIPTION:
@@ -707,4 +374,4 @@ _lua_set_globals() {
 }
 
 _lua_set_globals
-unset -f _lua_set_globals _lua_set_impls
+unset -f _lua_set_globals