guru/eclass/nim-utils.eclass

# Copyright 2022-2023 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2

# @ECLASS: nim-utils.eclass
# @MAINTAINER:
# Anna Vyalkova <cyber+gentoo@sysrq.in>
# @AUTHOR:
# Anna Vyalkova <cyber+gentoo@sysrq.in>
# @SUPPORTED_EAPIS: 8
# @BLURB: utility functions for Nim packages
# @DESCRIPTION:
# A utility eclass providing functions to call and configure Nim.
#
# This eclass does not set any metadata variables nor export any phase
# functions. It can be inherited safely.

case ${EAPI} in
	8) ;;
	*) die "${ECLASS}: EAPI ${EAPI} unsupported."
esac

if [[ ! ${_NIM_UTILS_ECLASS} ]]; then

# @ECLASS_VARIABLE: NIMFLAGS
# @USER_VARIABLE
# @DEFAULT_UNSET
# @DESCRIPTION:
# Flags for the Nim compiler.  Spaces need to be quoted or shell-escaped.
# Example:
#
# @CODE@
# # NIMFLAGS="-d:myFlag -d:myOpt:'my value'" emerge category/package
# @CODE@

# @ECLASS_VARIABLE: TESTAMENT_DISABLE_MEGATEST
# @USER_VARIABLE
# @DEFAULT_UNSET
# @DESCRIPTION:
# If set, pass '--megatest:off' to testament.

# @VARIABLE: ETESTAMENT_DESELECT
# @DEFAULT_UNSET
# @DESCRIPTION:
# Specifies an array of test files to be deselected via testament's --skipFrom
# parameter, when calling etestament.

inherit edo multiprocessing toolchain-funcs xdg-utils

# @FUNCTION: enim
# @USAGE: [<args>...]
# @DESCRIPTION:
# Call nim, passing the supplied arguments and NIMFLAGS.
# This function dies if nim fails. It also supports being called via 'nonfatal'.
# If you need to call nim directly in your ebuilds, this is the way it should
# be done.
enim() {
	debug-print-function ${FUNCNAME} "${@}"

	edo nim "${@}" ${NIMFLAGS}
}

# @FUNCTION: ekoch
# @USAGE: [<args>...]
# @DESCRIPTION:
# Call koch, passing the supplied arguments.  Used only for building compilers
# that originate from Nim.
# This function dies if koch fails.
ekoch() {
	debug-print-function ${FUNCNAME} "${@}"

	local koch
	case "${CATEGORY}/${PN}" in
		dev-lang/nim)
			koch="./koch"
			[[ -e ${koch} ]] || enim c koch
			;;
		*)
			eerror "${FUNCNAME} is not implemented for ${CATEGORY}/${PN}" ;;
	esac

	edo ${koch} "${@}"
}

# @FUNCTION: etestament
# @USAGE: [<args>...]
# @DESCRIPTION:
# Call testament, passing the supplied arguments.
# This function dies if testament fails.
etestament() {
	debug-print-function ${FUNCNAME} "${@}"

	local testament_args=(
		--colors:$(nim_get_colors)
	)

	[[ ${TESTAMENT_DISABLE_MEGATEST} ]] && \
		testament_args+=( --megatest:off )

	if [[ ${ETESTAMENT_DESELECT} ]]; then
		local skipfile="${T}"/testament-skipfile.txt
		if [[ ! -f ${skipfile} ]]; then
			printf "%s\n" "${ETESTAMENT_DESELECT[@]}" > "${skipfile}" || die
		else
			debug-print "${skipfile} already exists, not overwriting"
		fi
		testament_args+=( --skipFrom:"${skipfile}" )
	fi

	edo testament "${testament_args[@]}" "${@}"
}

# @FUNCTION: nim_get_buildtype
# @RETURN: build type (debug or release) based on USE flags
nim_get_buildtype() {
	if has debug ${IUSE}; then
		echo $(usex debug "debug" "release")
	else
		echo "release"
	fi
}

# @FUNCTION: nim_get_colors
# @RETURN: "off" if colors should be disabled, "on" otherwise
nim_get_colors() {
	case ${NOCOLOR} in
		true|yes) echo "off" ;;
		*)        echo "on" ;;
	esac
}

# @FUNCTION: nim_gen_config
# @USAGE: [<dir>]
# @DESCRIPTION:
# Generate a nim.cfg file in <dir> (default: $WORKDIR) to respect user's
# toolchain and preferences.
nim_gen_config() {
	debug-print-function ${FUNCNAME} "${@}"

	# bug 667182
	xdg_environment_reset

	local dir=${1:-${WORKDIR}}

	cat > "${dir}"/nim.cfg <<- EOF || die "Failed to create Nim config"
		cc:"gcc"
		gcc.exe:"$(tc-getCC)"
		gcc.linkerexe:"$(tc-getCC)"
		gcc.cpp.exe:"$(tc-getCXX)"
		gcc.cpp.linkerexe:"$(tc-getCXX)"
		gcc.options.speed:"${CFLAGS}"
		gcc.options.size:"${CFLAGS}"
		gcc.options.debug:"${CFLAGS}"
		gcc.options.always:"${CPPFLAGS}"
		gcc.options.linker:"${LDFLAGS}"
		gcc.cpp.options.speed:"${CXXFLAGS}"
		gcc.cpp.options.size:"${CXXFLAGS}"
		gcc.cpp.options.debug:"${CXXFLAGS}"
		gcc.cpp.options.always:"${CPPFLAGS}"
		gcc.cpp.options.linker:"${LDFLAGS}"

		-d:"$(nim_get_buildtype)"
		--colors:"$(nim_get_colors)"
		--parallelBuild:"$(makeopts_jobs)"
		--processing:filenames
	EOF
}

_NIM_UTILS_ECLASS=1
fi