gentoo-x86/eclass/cmake-utils.eclass

# Copyright 1999-2010 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.51 2010/04/30 23:58:47 abcd Exp $

# @ECLASS: cmake-utils.eclass
# @MAINTAINER:
# kde@gentoo.org
#
# @CODE
# Tomáš Chvátal <scarabeus@gentoo.org>
# Maciej Mrozowski <reavertm@gentoo.org>
# (undisclosed contributors)
# Original author: Zephyrus (zephyrus@mirach.it)
# @CODE
# @BLURB: common ebuild functions for cmake-based packages
# @DESCRIPTION:
# The cmake-utils eclass is base.eclass(5) wrapper that makes creating ebuilds for
# cmake-based packages much easier.
# It provides all inherited features (DOCS, HTML_DOCS, PATCHES) along with out-of-source
# builds (default), in-source builds and an implementation of the well-known use_enable
# and use_with functions for CMake.

# @ECLASS-VARIABLE: WANT_CMAKE
# @DESCRIPTION:
# Specify if cmake-utils eclass should depend on cmake optionaly or not.
# This is usefull when only part of aplication is using cmake build system.
# Valid values are: always [default], optional (where the value is the useflag
# used for optionality)
WANT_CMAKE="${WANT_CMAKE:-always}"

# @ECLASS-VARIABLE: CMAKE_MIN_VERSION
# @DESCRIPTION:
# Specify the minimum allowable version of cmake.  Defaults to 2.6.2-r1
CMAKE_MIN_VERSION="${CMAKE_MIN_VERSION:-2.6.2-r1}"

CMAKEDEPEND=""
case ${WANT_CMAKE} in
        always)
                ;;
        *)
                IUSE+=" ${WANT_CMAKE}"
                CMAKEDEPEND+="${WANT_CMAKE}? ( "
                ;;
esac
inherit toolchain-funcs multilib flag-o-matic base

CMAKE_EXPF="src_compile src_test src_install"
case ${EAPI:-0} in
        3|2) CMAKE_EXPF+=" src_configure" ;;
        1|0) ;;
        *) die "Unknown EAPI, Bug eclass maintainers." ;;
esac
EXPORT_FUNCTIONS ${CMAKE_EXPF}

: ${DESCRIPTION:="Based on the ${ECLASS} eclass"}

if [[ ${PN} != cmake ]]; then
        CMAKEDEPEND+=">=dev-util/cmake-${CMAKE_MIN_VERSION}"
fi

CMAKEDEPEND+=" userland_GNU? ( >=sys-apps/findutils-4.4.0 )"

[[ ${WANT_CMAKE} = always ]] || CMAKEDEPEND+=" )"

DEPEND="${CMAKEDEPEND}"
unset CMAKEDEPEND

# Internal functions used by cmake-utils_use_*
_use_me_now() {
        debug-print-function ${FUNCNAME} "$@"

        local uper capitalised x
        [[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]"
        if [[ ! -z $3 ]]; then
                # user specified the use name so use it
                echo "-D$1$3=$(use $2 && echo ON || echo OFF)"
        else
                # use all various most used combinations
                uper=$(echo ${2} | tr '[:lower:]' '[:upper:]')
                capitalised=$(echo ${2} | sed 's/\<\(.\)\([^ ]*\)/\u\1\L\2/g')
                for x in $2 $uper $capitalised; do
                        echo "-D$1$x=$(use $2 && echo ON || echo OFF) "
                done
        fi
}
_use_me_now_inverted() {
        debug-print-function ${FUNCNAME} "$@"

        local uper capitalised x
        [[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]"
        if [[ ! -z $3 ]]; then
                # user specified the use name so use it
                echo "-D$1$3=$(use $2 && echo OFF || echo ON)"
        else
                # use all various most used combinations
                uper=$(echo ${2} | tr '[:lower:]' '[:upper:]')
                capitalised=$(echo ${2} | sed 's/\<\(.\)\([^ ]*\)/\u\1\L\2/g')
                for x in $2 $uper $capitalised; do
                        echo "-D$1$x=$(use $2 && echo OFF || echo ON) "
                done
        fi
}

# @ECLASS-VARIABLE: PREFIX
# @DESCRIPTION:
# Eclass respects PREFIX variable, though it's not recommended way to set
# install/lib/bin prefixes.
# Use -DCMAKE_INSTALL_PREFIX=... CMake variable instead.

# @ECLASS-VARIABLE: CMAKE_IN_SOURCE_BUILD
# @DESCRIPTION:
# Set to enable in-source build.

# @ECLASS-VARIABLE: CMAKE_VERBOSE
# @DESCRIPTION:
# Set to enable verbose messages during compilation.

# @ECLASS-VARIABLE: CMAKE_BUILD_TYPE
# @DESCRIPTION:
# Set to override default CMAKE_BUILD_TYPE. Only useful for packages
# known to make use of "if (CMAKE_BUILD_TYPE MATCHES xxx)".
# If about to be set - needs to be set before invoking cmake-utils_src_configure.
# You usualy do *NOT* want nor need to set it as it pulls CMake default build-type
# specific compiler flags overriding make.conf.
: ${CMAKE_BUILD_TYPE:=Gentoo}

# Determine using IN or OUT source build
_check_build_dir() {
        # @ECLASS-VARIABLE: CMAKE_USE_DIR
        # @DESCRIPTION:
        # Sets the directory where we are working with cmake.
        # For example when application uses autotools and only one
        # plugin needs to be done by cmake.
        # By default it uses ${S}.
        : ${CMAKE_USE_DIR:=${S}}

        # @ECLASS-VARIABLE: CMAKE_BUILD_DIR
        # @DESCRIPTION:
        # Specify the build directory where all cmake processed
        # files should be located.
        #
        # For installing binary doins "${CMAKE_BUILD_DIR}/${PN}"
        if [[ -n ${CMAKE_IN_SOURCE_BUILD} ]]; then
                # we build in source dir
                CMAKE_BUILD_DIR="${CMAKE_USE_DIR}"
        elif [[ ${CMAKE_USE_DIR} = ${WORKDIR} ]]; then
                # out of tree build, but with $S=$WORKDIR, see bug #273949 for reason.
                CMAKE_BUILD_DIR="${CMAKE_USE_DIR}/build"
        else
                # regular out of tree build
                [[ ${1} = init || -d ${CMAKE_USE_DIR}_build ]] && SUF="_build" || SUF=""
                CMAKE_BUILD_DIR="${CMAKE_USE_DIR}${SUF}"
        fi
        echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\""
}
# @FUNCTION: cmake-utils_use_with
# @USAGE: <USE flag> [flag name]
# @DESCRIPTION:
# Based on use_with. See ebuild(5).
#
# `cmake-utils_use_with foo FOO` echoes -DWITH_FOO=ON if foo is enabled
# and -DWITH_FOO=OFF if it is disabled.
cmake-utils_use_with() { _use_me_now WITH_ "$@" ; }

# @FUNCTION: cmake-utils_use_enable
# @USAGE: <USE flag> [flag name]
# @DESCRIPTION:
# Based on use_enable. See ebuild(5).
#
# `cmake-utils_use_enable foo FOO` echoes -DENABLE_FOO=ON if foo is enabled
# and -DENABLE_FOO=OFF if it is disabled.
cmake-utils_use_enable() { _use_me_now ENABLE_ "$@" ; }

# @FUNCTION: cmake-utils_use_disable
# @USAGE: <USE flag> [flag name]
# @DESCRIPTION:
# Based on inversion of use_enable. See ebuild(5).
#
# `cmake-utils_use_enable foo FOO` echoes -DDISABLE_FOO=OFF if foo is enabled
# and -DDISABLE_FOO=ON if it is disabled.
cmake-utils_use_disable() { _use_me_now_inverted DISABLE_ "$@" ; }

# @FUNCTION: cmake-utils_use_no
# @USAGE: <USE flag> [flag name]
# @DESCRIPTION:
# Based on use_disable. See ebuild(5).
#
# `cmake-utils_use_no foo FOO` echoes -DNO_FOO=OFF if foo is enabled
# and -DNO_FOO=ON if it is disabled.
cmake-utils_use_no() { _use_me_now_inverted NO_ "$@" ; }

# @FUNCTION: cmake-utils_use_want
# @USAGE: <USE flag> [flag name]
# @DESCRIPTION:
# Based on use_enable. See ebuild(5).
#
# `cmake-utils_use_want foo FOO` echoes -DWANT_FOO=ON if foo is enabled
# and -DWANT_FOO=OFF if it is disabled.
cmake-utils_use_want() { _use_me_now WANT_ "$@" ; }

# @FUNCTION: cmake-utils_use_build
# @USAGE: <USE flag> [flag name]
# @DESCRIPTION:
# Based on use_enable. See ebuild(5).
#
# `cmake-utils_use_build foo FOO` echoes -DBUILD_FOO=ON if foo is enabled
# and -DBUILD_FOO=OFF if it is disabled.
cmake-utils_use_build() { _use_me_now BUILD_ "$@" ; }

# @FUNCTION: cmake-utils_use_has
# @USAGE: <USE flag> [flag name]
# @DESCRIPTION:
# Based on use_enable. See ebuild(5).
#
# `cmake-utils_use_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled
# and -DHAVE_FOO=OFF if it is disabled.
cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; }

# @FUNCTION: cmake-utils_use
# @USAGE: <USE flag> [flag name]
# @DESCRIPTION:
# Based on use_enable. See ebuild(5).
#
# `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled
# and -DFOO=OFF if it is disabled.
cmake-utils_use() { _use_me_now "" "$@" ; }

# Internal function for modifying hardcoded definitions.
# Removes dangerous definitions that override Gentoo settings.
_modify-cmakelists() {
        debug-print-function ${FUNCNAME} "$@"

        # Comment out all set (<some_should_be_user_defined_variable> value)
        # TODO Add QA checker - inform when variable being checked for below is set in CMakeLists.txt
        find "${CMAKE_USE_DIR}" -name CMakeLists.txt \
                -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_BUILD_TYPE.*)/{s/^/#IGNORE /g}' {} + \
                -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \
                || die "${LINENO}: failed to disable hardcoded settings"

        # NOTE Append some useful summary here
        cat >> CMakeLists.txt <<- _EOF_

                MESSAGE(STATUS "<<< Gentoo configuration >>>
                Build type      \${CMAKE_BUILD_TYPE}
                Install path    \${CMAKE_INSTALL_PREFIX}
                Compiler flags:
                C               \${CMAKE_C_FLAGS}
                C++             \${CMAKE_CXX_FLAGS}
                Linker flags:
                Executable      \${CMAKE_EXE_LINKER_FLAGS}
                Module          \${CMAKE_MODULE_LINKER_FLAGS}
                Shared          \${CMAKE_SHARED_LINKER_FLAGS}\n")
        _EOF_
}

enable_cmake-utils_src_configure() {
        debug-print-function ${FUNCNAME} "$@"

        _check_build_dir init

        # check if CMakeLists.txt exist and if no then die
        if [[ ! -e ${CMAKE_USE_DIR}/CMakeLists.txt ]] ; then
                eerror "Unable to locate CMakeLists.txt under:"
                eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\""
                eerror "Consider not inheriting the cmake eclass."
                die "FATAL: Unable to find CMakeLists.txt"
        fi

        # Remove dangerous things.
        _modify-cmakelists

        # Fix xdg collision with sandbox
        export XDG_CONFIG_HOME="${T}"

        # @SEE CMAKE_BUILD_TYPE
        if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then
                # Handle release builds
                if ! has debug ${IUSE//+} || ! use debug; then
                        append-cppflags -DNDEBUG
                fi
        fi

        # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
        local build_rules=${T}/gentoo_rules.cmake
        cat > "${build_rules}" <<- _EOF_
                SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
                SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
                SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
                SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE)
        _EOF_

        if use prefix; then
                cat >> "${build_rules}" <<- _EOF_
                        # in Prefix we need rpath and must ensure cmake gets our default linker path
                        # right ... except for Darwin hosts
                        IF (NOT APPLE)
                        SET (CMAKE_SKIP_RPATH OFF CACHE BOOL "" FORCE)
                        SET (CMAKE_PLATFORM_REQUIRED_RUNTIME_PATH "${EPREFIX}/usr/${CHOST}/lib/gcc;${EPREFIX}/usr/${CHOST}/lib;${EPREFIX}/usr/$(get_libdir);${EPREFIX}/$(get_libdir)"
                        CACHE STRING "" FORCE)
                        ENDIF (NOT APPLE)
                _EOF_
        fi

        # Common configure parameters (invariants)
        local common_config=${T}/gentoo_common_config.cmake
        local libdir=$(get_libdir)
        cat > "${common_config}" <<- _EOF_
                SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
                SET (CMAKE_INSTALL_LIBDIR ${libdir} CACHE PATH "Output directory for libraries")
        _EOF_
        [[ -n ${NOCOLOR} ]] || echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}"

        # Convert mycmakeargs to an array, for backwards compatibility
        # Make the array a local variable since <=portage-2.1.6.x does not
        # support global arrays (see bug #297255).
        if [[ $(declare -p mycmakeargs 2>&-) != "declare -a mycmakeargs="* ]]; then
                local mycmakeargs_local=(${mycmakeargs})
        else
                local mycmakeargs_local=("${mycmakeargs[@]}")
        fi

        has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=

        # Common configure parameters (overridable)
        # NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable
        # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect.
        local cmakeargs=(
                -C "${common_config}"
                -DCMAKE_INSTALL_PREFIX="${EPREFIX}${PREFIX:-/usr}"
                "${mycmakeargs_local[@]}"
                -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}"
                -DCMAKE_INSTALL_DO_STRIP=OFF
                -DCMAKE_USER_MAKE_RULES_OVERRIDE="${build_rules}"
                "${MYCMAKEARGS}"
        )

        mkdir -p "${CMAKE_BUILD_DIR}"
        pushd "${CMAKE_BUILD_DIR}" > /dev/null
        debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is ${mycmakeargs_local[*]}"
        echo cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}"
        cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" || die "cmake failed"

        popd > /dev/null
}

enable_cmake-utils_src_compile() {
        debug-print-function ${FUNCNAME} "$@"

        has src_configure ${CMAKE_EXPF} || cmake-utils_src_configure
        cmake-utils_src_make "$@"
}

# @FUNCTION: cmake-utils_src_make
# @DESCRIPTION:
# Function for building the package. Automatically detects the build type.
# All arguments are passed to emake
cmake-utils_src_make() {
        debug-print-function ${FUNCNAME} "$@"

        _check_build_dir
        pushd "${CMAKE_BUILD_DIR}" &> /dev/null
        # first check if Makefile exist otherwise die
        [[ -e Makefile ]] || die "Makefile not found. Error during configure stage."
        if [[ -n ${CMAKE_VERBOSE} ]]; then
                emake VERBOSE=1 "$@" || die "Make failed!"
        else
                emake "$@" || die "Make failed!"
        fi
        popd &> /dev/null
}

enable_cmake-utils_src_install() {
        debug-print-function ${FUNCNAME} "$@"

        _check_build_dir
        pushd "${CMAKE_BUILD_DIR}" &> /dev/null
        base_src_install
        popd &> /dev/null

        # Backward compatibility, for non-array variables
        if [[ -n "${DOCS}" ]] && [[ "$(declare -p DOCS 2>/dev/null 2>&1)" != "declare -a"* ]]; then
                dodoc ${DOCS} || die "dodoc failed"
        fi
        if [[ -n "${HTML_DOCS}" ]] && [[ "$(declare -p HTML_DOCS 2>/dev/null 2>&1)" != "declare -a"* ]]; then
                dohtml -r ${HTML_DOCS} || die "dohtml failed"
        fi
}

enable_cmake-utils_src_test() {
        debug-print-function ${FUNCNAME} "$@"

        _check_build_dir
        pushd "${CMAKE_BUILD_DIR}" &> /dev/null
        # Standard implementation of src_test
        if emake -j1 check -n &> /dev/null; then
                einfo ">>> Test phase [check]: ${CATEGORY}/${PF}"
                if ! emake -j1 check; then
                        die "Make check failed. See above for details."
                fi
        elif emake -j1 test -n &> /dev/null; then
                einfo ">>> Test phase [test]: ${CATEGORY}/${PF}"
                if ! emake -j1 test; then
                        die "Make test failed. See above for details."
                fi
        else
                einfo ">>> Test phase [none]: ${CATEGORY}/${PF}"
        fi
        popd &> /dev/null
}

# @FUNCTION: cmake-utils_src_configure
# @DESCRIPTION:
# General function for configuring with cmake. Default behaviour is to start an
# out-of-source build.
cmake-utils_src_configure() {
        _execute_optionaly "src_configure" "$@"
}

# @FUNCTION: cmake-utils_src_compile
# @DESCRIPTION:
# General function for compiling with cmake. Default behaviour is to check for
# EAPI and respectively to configure as well or just compile.
# Automatically detects the build type. All arguments are passed to emake.
cmake-utils_src_compile() {
        _execute_optionaly "src_compile" "$@"
}

# @FUNCTION: cmake-utils_src_install
# @DESCRIPTION:
# Function for installing the package. Automatically detects the build type.
cmake-utils_src_install() {
        _execute_optionaly "src_install" "$@"
}

# @FUNCTION: cmake-utils_src_test
# @DESCRIPTION:
# Function for testing the package. Automatically detects the build type.
cmake-utils_src_test() {
        _execute_optionaly "src_test" "$@"
}

# Optionally executes phases based on WANT_CMAKE variable/USE flag.
_execute_optionaly() {
        local phase="$1" ; shift
        if [[ ${WANT_CMAKE} = always ]]; then
                enable_cmake-utils_${phase} "$@"
        else
                use ${WANT_CMAKE} && enable_cmake-utils_${phase} "$@"
        fi
}
1	abcd	1.45	# Copyright 1999-2010 Gentoo Foundation
2	philantrop	1.1	# Distributed under the terms of the GNU General Public License v2
3	reavertm	1.52	# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.51 2010/04/30 23:58:47 abcd Exp $
4	philantrop	1.1
5			# @ECLASS: cmake-utils.eclass
6			# @MAINTAINER:
7			# kde@gentoo.org
8	scarabeus	1.23	#
9			# @CODE
10	scarabeus	1.17	# Tomáš Chvátal <scarabeus@gentoo.org>
11	reavertm	1.52	# Maciej Mrozowski <reavertm@gentoo.org>
12	scarabeus	1.17	# (undisclosed contributors)
13			# Original author: Zephyrus (zephyrus@mirach.it)
14	scarabeus	1.23	# @CODE
15	philantrop	1.1	# @BLURB: common ebuild functions for cmake-based packages
16			# @DESCRIPTION:
17	reavertm	1.52	# The cmake-utils eclass is base.eclass(5) wrapper that makes creating ebuilds for
18	philantrop	1.1	# cmake-based packages much easier.
19	reavertm	1.52	# It provides all inherited features (DOCS, HTML_DOCS, PATCHES) along with out-of-source
20			# builds (default), in-source builds and an implementation of the well-known use_enable
21			# and use_with functions for CMake.
22	philantrop	1.1
23	scarabeus	1.32	# @ECLASS-VARIABLE: WANT_CMAKE
24			# @DESCRIPTION:
25			# Specify if cmake-utils eclass should depend on cmake optionaly or not.
26			# This is usefull when only part of aplication is using cmake build system.
27			# Valid values are: always [default], optional (where the value is the useflag
28			# used for optionality)
29			WANT_CMAKE="${WANT_CMAKE:-always}"
30	abcd	1.50
31	abcd	1.51	# @ECLASS-VARIABLE: CMAKE_MIN_VERSION
32	abcd	1.50	# @DESCRIPTION:
33			# Specify the minimum allowable version of cmake. Defaults to 2.6.2-r1
34	abcd	1.51	CMAKE_MIN_VERSION="${CMAKE_MIN_VERSION:-2.6.2-r1}"
35	abcd	1.50
36	scarabeus	1.32	CMAKEDEPEND=""
37			case ${WANT_CMAKE} in
38	reavertm	1.49	always)
39			;;
40			*)
41			IUSE+=" ${WANT_CMAKE}"
42			CMAKEDEPEND+="${WANT_CMAKE}? ( "
43			;;
44	scarabeus	1.32	esac
45	scarabeus	1.17	inherit toolchain-funcs multilib flag-o-matic base
46	philantrop	1.1
47	scarabeus	1.32	CMAKE_EXPF="src_compile src_test src_install"
48	scarabeus	1.17	case ${EAPI:-0} in
49	abcd	1.35	3\|2) CMAKE_EXPF+=" src_configure" ;;
50	scarabeus	1.17	1\|0) ;;
51			*) die "Unknown EAPI, Bug eclass maintainers." ;;
52	jmbsvicetto	1.10	esac
53	scarabeus	1.32	EXPORT_FUNCTIONS ${CMAKE_EXPF}
54	jmbsvicetto	1.10
55	scarabeus	1.17	: ${DESCRIPTION:="Based on the ${ECLASS} eclass"}
56	philantrop	1.1
57	scarabeus	1.23	if [[ ${PN} != cmake ]]; then
58	abcd	1.51	CMAKEDEPEND+=">=dev-util/cmake-${CMAKE_MIN_VERSION}"
59	scarabeus	1.23	fi
60
61	mr_bones_	1.34	CMAKEDEPEND+=" userland_GNU? ( >=sys-apps/findutils-4.4.0 )"
62	scarabeus	1.32
63			[[ ${WANT_CMAKE} = always ]] \|\| CMAKEDEPEND+=" )"
64
65			DEPEND="${CMAKEDEPEND}"
66			unset CMAKEDEPEND
67	scarabeus	1.17
68			# Internal functions used by cmake-utils_use_*
69	philantrop	1.1	_use_me_now() {
70	scarabeus	1.17	debug-print-function ${FUNCNAME} "$@"
71	scarabeus	1.23
72			local uper capitalised x
73	philantrop	1.1	[[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]"
74	scarabeus	1.23	if [[ ! -z $3 ]]; then
75			# user specified the use name so use it
76			echo "-D$1$3=$(use $2 && echo ON \|\| echo OFF)"
77			else
78			# use all various most used combinations
79			uper=$(echo ${2} \| tr '[:lower:]' '[:upper:]')
80			capitalised=$(echo ${2} \| sed 's/\<\(.\)\([^ ]*\)/\u\1\L\2/g')
81			for x in $2 $uper $capitalised; do
82			echo "-D$1$x=$(use $2 && echo ON \|\| echo OFF) "
83			done
84			fi
85	philantrop	1.1	}
86	scarabeus	1.17	_use_me_now_inverted() {
87			debug-print-function ${FUNCNAME} "$@"
88	scarabeus	1.23
89			local uper capitalised x
90	scarabeus	1.17	[[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]"
91	scarabeus	1.23	if [[ ! -z $3 ]]; then
92			# user specified the use name so use it
93			echo "-D$1$3=$(use $2 && echo OFF \|\| echo ON)"
94			else
95			# use all various most used combinations
96			uper=$(echo ${2} \| tr '[:lower:]' '[:upper:]')
97			capitalised=$(echo ${2} \| sed 's/\<\(.\)\([^ ]*\)/\u\1\L\2/g')
98			for x in $2 $uper $capitalised; do
99			echo "-D$1$x=$(use $2 && echo OFF \|\| echo ON) "
100			done
101			fi
102	scarabeus	1.17	}
103
104			# @ECLASS-VARIABLE: PREFIX
105	scarabeus	1.23	# @DESCRIPTION:
106	scarabeus	1.17	# Eclass respects PREFIX variable, though it's not recommended way to set
107			# install/lib/bin prefixes.
108			# Use -DCMAKE_INSTALL_PREFIX=... CMake variable instead.
109
110			# @ECLASS-VARIABLE: CMAKE_IN_SOURCE_BUILD
111			# @DESCRIPTION:
112			# Set to enable in-source build.
113
114			# @ECLASS-VARIABLE: CMAKE_VERBOSE
115			# @DESCRIPTION:
116			# Set to enable verbose messages during compilation.
117
118			# @ECLASS-VARIABLE: CMAKE_BUILD_TYPE
119			# @DESCRIPTION:
120			# Set to override default CMAKE_BUILD_TYPE. Only useful for packages
121			# known to make use of "if (CMAKE_BUILD_TYPE MATCHES xxx)".
122			# If about to be set - needs to be set before invoking cmake-utils_src_configure.
123			# You usualy do NOT want nor need to set it as it pulls CMake default build-type
124			# specific compiler flags overriding make.conf.
125			: ${CMAKE_BUILD_TYPE:=Gentoo}
126
127			# Determine using IN or OUT source build
128			_check_build_dir() {
129	scarabeus	1.26	# @ECLASS-VARIABLE: CMAKE_USE_DIR
130			# @DESCRIPTION:
131			# Sets the directory where we are working with cmake.
132			# For example when application uses autotools and only one
133			# plugin needs to be done by cmake.
134			# By default it uses ${S}.
135			: ${CMAKE_USE_DIR:=${S}}
136
137	scarabeus	1.27	# @ECLASS-VARIABLE: CMAKE_BUILD_DIR
138			# @DESCRIPTION:
139			# Specify the build directory where all cmake processed
140			# files should be located.
141			#
142			# For installing binary doins "${CMAKE_BUILD_DIR}/${PN}"
143	abcd	1.35	if [[ -n ${CMAKE_IN_SOURCE_BUILD} ]]; then
144	scarabeus	1.29	# we build in source dir
145	scarabeus	1.26	CMAKE_BUILD_DIR="${CMAKE_USE_DIR}"
146	scarabeus	1.29	elif [[ ${CMAKE_USE_DIR} = ${WORKDIR} ]]; then
147			# out of tree build, but with $S=$WORKDIR, see bug #273949 for reason.
148			CMAKE_BUILD_DIR="${CMAKE_USE_DIR}/build"
149	scarabeus	1.17	else
150	scarabeus	1.29	# regular out of tree build
151	scarabeus	1.28	[[ ${1} = init \|\| -d ${CMAKE_USE_DIR}_build ]] && SUF="_build" \|\| SUF=""
152			CMAKE_BUILD_DIR="${CMAKE_USE_DIR}${SUF}"
153	scarabeus	1.17	fi
154			echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\""
155			}
156	philantrop	1.1	# @FUNCTION: cmake-utils_use_with
157			# @USAGE: <USE flag> [flag name]
158			# @DESCRIPTION:
159	philantrop	1.3	# Based on use_with. See ebuild(5).
160	betelgeuse	1.4	#
161	philantrop	1.3	# `cmake-utils_use_with foo FOO` echoes -DWITH_FOO=ON if foo is enabled
162			# and -DWITH_FOO=OFF if it is disabled.
163	scarabeus	1.20	cmake-utils_use_with() { _use_me_now WITH_ "$@" ; }
164	philantrop	1.1
165			# @FUNCTION: cmake-utils_use_enable
166			# @USAGE: <USE flag> [flag name]
167			# @DESCRIPTION:
168	philantrop	1.3	# Based on use_enable. See ebuild(5).
169	betelgeuse	1.4	#
170	philantrop	1.3	# `cmake-utils_use_enable foo FOO` echoes -DENABLE_FOO=ON if foo is enabled
171			# and -DENABLE_FOO=OFF if it is disabled.
172	scarabeus	1.20	cmake-utils_use_enable() { _use_me_now ENABLE_ "$@" ; }
173	philantrop	1.1
174	scarabeus	1.17	# @FUNCTION: cmake-utils_use_disable
175			# @USAGE: <USE flag> [flag name]
176			# @DESCRIPTION:
177			# Based on inversion of use_enable. See ebuild(5).
178			#
179			# `cmake-utils_use_enable foo FOO` echoes -DDISABLE_FOO=OFF if foo is enabled
180			# and -DDISABLE_FOO=ON if it is disabled.
181	scarabeus	1.20	cmake-utils_use_disable() { _use_me_now_inverted DISABLE_ "$@" ; }
182	scarabeus	1.17
183			# @FUNCTION: cmake-utils_use_no
184			# @USAGE: <USE flag> [flag name]
185			# @DESCRIPTION:
186			# Based on use_disable. See ebuild(5).
187			#
188			# `cmake-utils_use_no foo FOO` echoes -DNO_FOO=OFF if foo is enabled
189			# and -DNO_FOO=ON if it is disabled.
190	scarabeus	1.20	cmake-utils_use_no() { _use_me_now_inverted NO_ "$@" ; }
191	scarabeus	1.17
192	philantrop	1.2	# @FUNCTION: cmake-utils_use_want
193			# @USAGE: <USE flag> [flag name]
194			# @DESCRIPTION:
195	philantrop	1.3	# Based on use_enable. See ebuild(5).
196	betelgeuse	1.4	#
197	philantrop	1.3	# `cmake-utils_use_want foo FOO` echoes -DWANT_FOO=ON if foo is enabled
198			# and -DWANT_FOO=OFF if it is disabled.
199	scarabeus	1.20	cmake-utils_use_want() { _use_me_now WANT_ "$@" ; }
200	philantrop	1.2
201	scarabeus	1.17	# @FUNCTION: cmake-utils_use_build
202			# @USAGE: <USE flag> [flag name]
203			# @DESCRIPTION:
204			# Based on use_enable. See ebuild(5).
205			#
206			# `cmake-utils_use_build foo FOO` echoes -DBUILD_FOO=ON if foo is enabled
207			# and -DBUILD_FOO=OFF if it is disabled.
208	scarabeus	1.20	cmake-utils_use_build() { _use_me_now BUILD_ "$@" ; }
209	scarabeus	1.17
210			# @FUNCTION: cmake-utils_use_has
211			# @USAGE: <USE flag> [flag name]
212			# @DESCRIPTION:
213			# Based on use_enable. See ebuild(5).
214			#
215			# `cmake-utils_use_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled
216			# and -DHAVE_FOO=OFF if it is disabled.
217	scarabeus	1.20	cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; }
218	scarabeus	1.17
219			# @FUNCTION: cmake-utils_use
220	philantrop	1.3	# @USAGE: <USE flag> [flag name]
221			# @DESCRIPTION:
222			# Based on use_enable. See ebuild(5).
223	betelgeuse	1.4	#
224	scarabeus	1.17	# `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled
225			# and -DFOO=OFF if it is disabled.
226			cmake-utils_use() { _use_me_now "" "$@" ; }
227
228			# Internal function for modifying hardcoded definitions.
229	abcd	1.40	# Removes dangerous definitions that override Gentoo settings.
230	scarabeus	1.17	_modify-cmakelists() {
231			debug-print-function ${FUNCNAME} "$@"
232
233			# Comment out all set (<some_should_be_user_defined_variable> value)
234			# TODO Add QA checker - inform when variable being checked for below is set in CMakeLists.txt
235	scarabeus	1.26	find "${CMAKE_USE_DIR}" -name CMakeLists.txt \
236	scarabeus	1.17	-exec sed -i -e '/^[[:space:]][sS][eE][tT][[:space:]]([[:space:]]CMAKE_BUILD_TYPE.)/{s/^/#IGNORE /g}' {} + \
237			-exec sed -i -e '/^[[:space:]][sS][eE][tT][[:space:]]([[:space:]]CMAKE_INSTALL_PREFIX.)/{s/^/#IGNORE /g}' {} + \
238			\|\| die "${LINENO}: failed to disable hardcoded settings"
239
240			# NOTE Append some useful summary here
241	abcd	1.35	cat >> CMakeLists.txt <<- _EOF_
242	abcd	1.36
243	abcd	1.35	MESSAGE(STATUS "<<< Gentoo configuration >>>
244	reavertm	1.49	Build type \${CMAKE_BUILD_TYPE}
245			Install path \${CMAKE_INSTALL_PREFIX}
246			Compiler flags:
247			C \${CMAKE_C_FLAGS}
248			C++ \${CMAKE_CXX_FLAGS}
249			Linker flags:
250			Executable \${CMAKE_EXE_LINKER_FLAGS}
251			Module \${CMAKE_MODULE_LINKER_FLAGS}
252			Shared \${CMAKE_SHARED_LINKER_FLAGS}\n")
253	abcd	1.35	_EOF_
254	scarabeus	1.17	}
255	philantrop	1.3
256	scarabeus	1.32	enable_cmake-utils_src_configure() {
257	scarabeus	1.17	debug-print-function ${FUNCNAME} "$@"
258	philantrop	1.1
259	scarabeus	1.28	_check_build_dir init
260	scarabeus	1.26
261	scarabeus	1.24	# check if CMakeLists.txt exist and if no then die
262	abcd	1.35	if [[ ! -e ${CMAKE_USE_DIR}/CMakeLists.txt ]] ; then
263	reavertm	1.49	eerror "Unable to locate CMakeLists.txt under:"
264	scarabeus	1.26	eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\""
265	reavertm	1.49	eerror "Consider not inheriting the cmake eclass."
266	scarabeus	1.24	die "FATAL: Unable to find CMakeLists.txt"
267			fi
268
269	scarabeus	1.17	# Remove dangerous things.
270			_modify-cmakelists
271
272	scarabeus	1.32	# Fix xdg collision with sandbox
273			export XDG_CONFIG_HOME="${T}"
274
275	scarabeus	1.17	# @SEE CMAKE_BUILD_TYPE
276			if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then
277			# Handle release builds
278			if ! has debug ${IUSE//+} \|\| ! use debug; then
279			append-cppflags -DNDEBUG
280			fi
281	philantrop	1.2	fi
282	scarabeus	1.17
283			# Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
284	abcd	1.35	local build_rules=${T}/gentoo_rules.cmake
285			cat > "${build_rules}" <<- _EOF_
286			SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
287			SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
288			SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
289			SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE)
290			_EOF_
291
292			if use prefix; then
293			cat >> "${build_rules}" <<- _EOF_
294			# in Prefix we need rpath and must ensure cmake gets our default linker path
295			# right ... except for Darwin hosts
296			IF (NOT APPLE)
297			SET (CMAKE_SKIP_RPATH OFF CACHE BOOL "" FORCE)
298			SET (CMAKE_PLATFORM_REQUIRED_RUNTIME_PATH "${EPREFIX}/usr/${CHOST}/lib/gcc;${EPREFIX}/usr/${CHOST}/lib;${EPREFIX}/usr/$(get_libdir);${EPREFIX}/$(get_libdir)"
299			CACHE STRING "" FORCE)
300			ENDIF (NOT APPLE)
301			_EOF_
302			fi
303
304			# Common configure parameters (invariants)
305			local common_config=${T}/gentoo_common_config.cmake
306			local libdir=$(get_libdir)
307			cat > "${common_config}" <<- _EOF_
308			SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
309	robbat2	1.48	SET (CMAKE_INSTALL_LIBDIR ${libdir} CACHE PATH "Output directory for libraries")
310	abcd	1.35	_EOF_
311	scarabeus	1.39	[[ -n ${NOCOLOR} ]] \|\| echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}"
312	abcd	1.35
313			# Convert mycmakeargs to an array, for backwards compatibility
314	zmedico	1.38	# Make the array a local variable since <=portage-2.1.6.x does not
315			# support global arrays (see bug #297255).
316	abcd	1.36	if [[ $(declare -p mycmakeargs 2>&-) != "declare -a mycmakeargs="* ]]; then
317	zmedico	1.38	local mycmakeargs_local=(${mycmakeargs})
318			else
319			local mycmakeargs_local=("${mycmakeargs[@]}")
320	abcd	1.35	fi
321
322			has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=
323	scarabeus	1.17
324			# Common configure parameters (overridable)
325			# NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable
326			# No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect.
327	abcd	1.35	local cmakeargs=(
328			-C "${common_config}"
329	abcd	1.37	-DCMAKE_INSTALL_PREFIX="${EPREFIX}${PREFIX:-/usr}"
330	zmedico	1.38	"${mycmakeargs_local[@]}"
331	abcd	1.35	-DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}"
332	scarabeus	1.17	-DCMAKE_INSTALL_DO_STRIP=OFF
333	abcd	1.35	-DCMAKE_USER_MAKE_RULES_OVERRIDE="${build_rules}"
334	ssuominen	1.47	"${MYCMAKEARGS}"
335	abcd	1.35	)
336	scarabeus	1.17
337			mkdir -p "${CMAKE_BUILD_DIR}"
338			pushd "${CMAKE_BUILD_DIR}" > /dev/null
339	zmedico	1.38	debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is ${mycmakeargs_local[*]}"
340	abcd	1.35	echo cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}"
341			cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" \|\| die "cmake failed"
342	scarabeus	1.17
343			popd > /dev/null
344	jmbsvicetto	1.9	}
345
346	scarabeus	1.32	enable_cmake-utils_src_compile() {
347	scarabeus	1.17	debug-print-function ${FUNCNAME} "$@"
348	jmbsvicetto	1.9
349	scarabeus	1.32	has src_configure ${CMAKE_EXPF} \|\| cmake-utils_src_configure
350	philantrop	1.3	cmake-utils_src_make "$@"
351	philantrop	1.1	}
352
353			# @FUNCTION: cmake-utils_src_make
354			# @DESCRIPTION:
355			# Function for building the package. Automatically detects the build type.
356	abcd	1.35	# All arguments are passed to emake
357	philantrop	1.1	cmake-utils_src_make() {
358	scarabeus	1.17	debug-print-function ${FUNCNAME} "$@"
359	philantrop	1.1
360	scarabeus	1.17	_check_build_dir
361	scarabeus	1.28	pushd "${CMAKE_BUILD_DIR}" &> /dev/null
362	scarabeus	1.25	# first check if Makefile exist otherwise die
363			[[ -e Makefile ]] \|\| die "Makefile not found. Error during configure stage."
364	scarabeus	1.17	if [[ -n ${CMAKE_VERBOSE} ]]; then
365	philantrop	1.3	emake VERBOSE=1 "$@" \|\| die "Make failed!"
366	philantrop	1.1	else
367	philantrop	1.3	emake "$@" \|\| die "Make failed!"
368	philantrop	1.2	fi
369	scarabeus	1.28	popd &> /dev/null
370	philantrop	1.1	}
371
372	scarabeus	1.32	enable_cmake-utils_src_install() {
373	scarabeus	1.17	debug-print-function ${FUNCNAME} "$@"
374	philantrop	1.1
375	scarabeus	1.17	_check_build_dir
376	scarabeus	1.28	pushd "${CMAKE_BUILD_DIR}" &> /dev/null
377	reavertm	1.52	base_src_install
378	scarabeus	1.28	popd &> /dev/null
379	zlin	1.5
380	reavertm	1.52	# Backward compatibility, for non-array variables
381			if [[ -n "${DOCS}" ]] && [[ "$(declare -p DOCS 2>/dev/null 2>&1)" != "declare -a"* ]]; then
382			dodoc ${DOCS} \|\| die "dodoc failed"
383			fi
384			if [[ -n "${HTML_DOCS}" ]] && [[ "$(declare -p HTML_DOCS 2>/dev/null 2>&1)" != "declare -a"* ]]; then
385			dohtml -r ${HTML_DOCS} \|\| die "dohtml failed"
386			fi
387	philantrop	1.1	}
388
389	scarabeus	1.32	enable_cmake-utils_src_test() {
390	scarabeus	1.17	debug-print-function ${FUNCNAME} "$@"
391	philantrop	1.1
392	scarabeus	1.17	_check_build_dir
393	scarabeus	1.28	pushd "${CMAKE_BUILD_DIR}" &> /dev/null
394	philantrop	1.1	# Standard implementation of src_test
395			if emake -j1 check -n &> /dev/null; then
396			einfo ">>> Test phase [check]: ${CATEGORY}/${PF}"
397			if ! emake -j1 check; then
398			die "Make check failed. See above for details."
399			fi
400			elif emake -j1 test -n &> /dev/null; then
401			einfo ">>> Test phase [test]: ${CATEGORY}/${PF}"
402			if ! emake -j1 test; then
403			die "Make test failed. See above for details."
404			fi
405			else
406			einfo ">>> Test phase [none]: ${CATEGORY}/${PF}"
407			fi
408	scarabeus	1.28	popd &> /dev/null
409	philantrop	1.1	}
410	scarabeus	1.32
411			# @FUNCTION: cmake-utils_src_configure
412			# @DESCRIPTION:
413	reavertm	1.52	# General function for configuring with cmake. Default behaviour is to start an
414			# out-of-source build.
415	scarabeus	1.32	cmake-utils_src_configure() {
416	scarabeus	1.42	_execute_optionaly "src_configure" "$@"
417	scarabeus	1.32	}
418
419			# @FUNCTION: cmake-utils_src_compile
420			# @DESCRIPTION:
421	reavertm	1.52	# General function for compiling with cmake. Default behaviour is to check for
422			# EAPI and respectively to configure as well or just compile.
423			# Automatically detects the build type. All arguments are passed to emake.
424	scarabeus	1.32	cmake-utils_src_compile() {
425	scarabeus	1.42	_execute_optionaly "src_compile" "$@"
426	scarabeus	1.32	}
427
428			# @FUNCTION: cmake-utils_src_install
429			# @DESCRIPTION:
430	reavertm	1.52	# Function for installing the package. Automatically detects the build type.
431	scarabeus	1.32	cmake-utils_src_install() {
432	scarabeus	1.42	_execute_optionaly "src_install" "$@"
433	scarabeus	1.32	}
434
435			# @FUNCTION: cmake-utils_src_test
436			# @DESCRIPTION:
437	reavertm	1.52	# Function for testing the package. Automatically detects the build type.
438	scarabeus	1.32	cmake-utils_src_test() {
439	scarabeus	1.42	_execute_optionaly "src_test" "$@"
440	scarabeus	1.32	}
441
442	reavertm	1.52	# Optionally executes phases based on WANT_CMAKE variable/USE flag.
443	scarabeus	1.32	_execute_optionaly() {
444	scarabeus	1.42	local phase="$1" ; shift
445	scarabeus	1.32	if [[ ${WANT_CMAKE} = always ]]; then
446	scarabeus	1.42	enable_cmake-utils_${phase} "$@"
447	scarabeus	1.32	else
448	scarabeus	1.42	use ${WANT_CMAKE} && enable_cmake-utils_${phase} "$@"
449	scarabeus	1.32	fi
450			}