gentoo-x86/eclass/cmake-utils.eclass

# Copyright 1999-2009 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.24 2009/04/10 20:24:56 scarabeus Exp $

# @ECLASS: cmake-utils.eclass
# @MAINTAINER:
# kde@gentoo.org
#
# @CODE
# Tomáš Chvátal <scarabeus@gentoo.org>
# Maciej Mrozowski <reavertm@poczta.fm>
# (undisclosed contributors)
# Original author: Zephyrus (zephyrus@mirach.it)
# @CODE
# @BLURB: common ebuild functions for cmake-based packages
# @DESCRIPTION:
# The cmake-utils eclass contains functions that make creating ebuilds for
# cmake-based packages much easier.
# Its main features are support of out-of-source builds as well as in-source
# builds and an implementation of the well-known use_enable and use_with
# functions for CMake.

inherit toolchain-funcs multilib flag-o-matic base

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

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

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

DEPEND="${CMAKEDEPEND}
        userland_GNU? ( >=sys-apps/findutils-4.4.0 )
"

# 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: DOCS
# @DESCRIPTION:
# Documents passed to dodoc command.

# @ECLASS-VARIABLE: HTML_DOCS
# @DESCRIPTION:
# Documents passed to dohtml command.

# @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_NO_COLOR
# @DESCRIPTION:
# Set to disable cmake output coloring.

# @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}

# @FUNCTION: _check_build_dir
# @DESCRIPTION:
# Determine using IN or OUT source build
_check_build_dir() {
        # in/out source build
        if [[ -n "${CMAKE_IN_SOURCE_BUILD}" ]]; then
                CMAKE_BUILD_DIR="${S}"
        else
                CMAKE_BUILD_DIR="${WORKDIR}/${PN}_build"
        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_has
# @DESCRIPTION:
# Deprecated, use cmake-utils_use_has, kept now for backcompat.
cmake-utils_has() { ewarn "QA notice: using deprecated ${FUNCNAME} call, use cmake-utils_use_has instead." ; _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 definitionts 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 "${S}" -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
        echo '
MESSAGE(STATUS "<<< Gentoo configuration >>>
Build type: ${CMAKE_BUILD_TYPE}
Install path: ${CMAKE_INSTALL_PREFIX}\n")' >> CMakeLists.txt
}

# @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() {
        debug-print-function ${FUNCNAME} "$@"

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

        # Remove dangerous things.
        _modify-cmakelists

        # @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="${TMPDIR}"/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_

        # 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="
                -DCMAKE_INSTALL_PREFIX=${PREFIX:-/usr}
                ${mycmakeargs}
                -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
                -DCMAKE_INSTALL_DO_STRIP=OFF
                -DCMAKE_USER_MAKE_RULES_OVERRIDE=${build_rules}"

        # Common configure parameters (invariants)
        local common_config="${TMPDIR}"/gentoo_common_config.cmake
        local libdir=$(get_libdir)
cat > ${common_config} << _EOF_
SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
_EOF_
        [[ -n ${CMAKE_NO_COLOR} ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> ${common_config}
        cmakeargs="-C ${common_config} ${cmakeargs}"

        _check_build_dir
        mkdir -p "${CMAKE_BUILD_DIR}"
        pushd "${CMAKE_BUILD_DIR}" > /dev/null
        debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is $cmakeargs"
        cmake ${cmakeargs} "${S}" || die "cmake failed"

        popd > /dev/null
}

# @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.
cmake-utils_src_compile() {
        debug-print-function ${FUNCNAME} "$@"

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

# @FUNCTION: cmake-utils_src_configurein
# @DESCRIPTION:
# Deprecated
cmake-utils_src_configurein() {
        ewarn "QA notice: using deprecated ${FUNCNAME} call, set CMAKE_IN_SOURCE_BUILD=1 instead."
        cmake-utils_src_configure
}

# @FUNCTION: cmake-utils_src_configureout
# @DESCRIPTION:
# Deprecated
cmake-utils_src_configureout() {
        ewarn "QA notice: using deprecated ${FUNCNAME} call, out of source build is enabled by default."
        cmake-utils_src_configure
}

# @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
}

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

        _check_build_dir
        pushd "${CMAKE_BUILD_DIR}" > /dev/null
        emake install DESTDIR="${D}" || die "Make install failed"
        popd > /dev/null

        # Manual document installation
        [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; }
        [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; }
}

# @FUNCTION: cmake-utils_src_test
# @DESCRIPTION:
# Function for testing the package. Automatically detects the build type.
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
}
1	fauli	1.19	# Copyright 1999-2009 Gentoo Foundation
2	philantrop	1.1	# Distributed under the terms of the GNU General Public License v2
3	scarabeus	1.25	# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.24 2009/04/10 20:24:56 scarabeus 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			# Maciej Mrozowski <reavertm@poczta.fm>
12			# (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			# The cmake-utils eclass contains functions that make creating ebuilds for
18			# cmake-based packages much easier.
19			# Its main features are support of out-of-source builds as well as in-source
20			# builds and an implementation of the well-known use_enable and use_with
21			# functions for CMake.
22
23	scarabeus	1.17	inherit toolchain-funcs multilib flag-o-matic base
24	philantrop	1.1
25	scarabeus	1.17	EXPF="src_compile src_test src_install"
26			case ${EAPI:-0} in
27			2) EXPF="${EXPF} src_configure"
28	jmbsvicetto	1.10	;;
29	scarabeus	1.17	1\|0) ;;
30			*) die "Unknown EAPI, Bug eclass maintainers." ;;
31	jmbsvicetto	1.10	esac
32	scarabeus	1.17	EXPORT_FUNCTIONS ${EXPF}
33	jmbsvicetto	1.10
34	scarabeus	1.17	: ${DESCRIPTION:="Based on the ${ECLASS} eclass"}
35	philantrop	1.1
36	scarabeus	1.23	if [[ ${PN} != cmake ]]; then
37			CMAKEDEPEND=">=dev-util/cmake-2.6.2-r1"
38			fi
39
40			DEPEND="${CMAKEDEPEND}
41	scarabeus	1.22	userland_GNU? ( >=sys-apps/findutils-4.4.0 )
42			"
43	scarabeus	1.17
44			# Internal functions used by cmake-utils_use_*
45	philantrop	1.1	_use_me_now() {
46	scarabeus	1.17	debug-print-function ${FUNCNAME} "$@"
47	scarabeus	1.23
48			local uper capitalised x
49	philantrop	1.1	[[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]"
50	scarabeus	1.23	if [[ ! -z $3 ]]; then
51			# user specified the use name so use it
52			echo "-D$1$3=$(use $2 && echo ON \|\| echo OFF)"
53			else
54			# use all various most used combinations
55			uper=$(echo ${2} \| tr '[:lower:]' '[:upper:]')
56			capitalised=$(echo ${2} \| sed 's/\<\(.\)\([^ ]*\)/\u\1\L\2/g')
57			for x in $2 $uper $capitalised; do
58			echo "-D$1$x=$(use $2 && echo ON \|\| echo OFF) "
59			done
60			fi
61	philantrop	1.1	}
62	scarabeus	1.17	_use_me_now_inverted() {
63			debug-print-function ${FUNCNAME} "$@"
64	scarabeus	1.23
65			local uper capitalised x
66	scarabeus	1.17	[[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]"
67	scarabeus	1.23	if [[ ! -z $3 ]]; then
68			# user specified the use name so use it
69			echo "-D$1$3=$(use $2 && echo OFF \|\| echo ON)"
70			else
71			# use all various most used combinations
72			uper=$(echo ${2} \| tr '[:lower:]' '[:upper:]')
73			capitalised=$(echo ${2} \| sed 's/\<\(.\)\([^ ]*\)/\u\1\L\2/g')
74			for x in $2 $uper $capitalised; do
75			echo "-D$1$x=$(use $2 && echo OFF \|\| echo ON) "
76			done
77			fi
78	scarabeus	1.17	}
79
80			# @ECLASS-VARIABLE: DOCS
81			# @DESCRIPTION:
82			# Documents passed to dodoc command.
83	philantrop	1.1
84	scarabeus	1.17	# @ECLASS-VARIABLE: HTML_DOCS
85	zlin	1.5	# @DESCRIPTION:
86	scarabeus	1.17	# Documents passed to dohtml command.
87	zlin	1.5
88	scarabeus	1.17	# @ECLASS-VARIABLE: PREFIX
89	scarabeus	1.23	# @DESCRIPTION:
90	scarabeus	1.17	# Eclass respects PREFIX variable, though it's not recommended way to set
91			# install/lib/bin prefixes.
92			# Use -DCMAKE_INSTALL_PREFIX=... CMake variable instead.
93
94			# @ECLASS-VARIABLE: CMAKE_IN_SOURCE_BUILD
95			# @DESCRIPTION:
96			# Set to enable in-source build.
97
98			# @ECLASS-VARIABLE: CMAKE_NO_COLOR
99			# @DESCRIPTION:
100			# Set to disable cmake output coloring.
101
102			# @ECLASS-VARIABLE: CMAKE_VERBOSE
103			# @DESCRIPTION:
104			# Set to enable verbose messages during compilation.
105
106			# @ECLASS-VARIABLE: CMAKE_BUILD_TYPE
107			# @DESCRIPTION:
108			# Set to override default CMAKE_BUILD_TYPE. Only useful for packages
109			# known to make use of "if (CMAKE_BUILD_TYPE MATCHES xxx)".
110			# If about to be set - needs to be set before invoking cmake-utils_src_configure.
111			# You usualy do NOT want nor need to set it as it pulls CMake default build-type
112			# specific compiler flags overriding make.conf.
113			: ${CMAKE_BUILD_TYPE:=Gentoo}
114
115			# @FUNCTION: _check_build_dir
116			# @DESCRIPTION:
117			# Determine using IN or OUT source build
118			_check_build_dir() {
119			# in/out source build
120			if [[ -n "${CMAKE_IN_SOURCE_BUILD}" ]]; then
121			CMAKE_BUILD_DIR="${S}"
122			else
123			CMAKE_BUILD_DIR="${WORKDIR}/${PN}_build"
124			fi
125			echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\""
126			}
127	philantrop	1.1	# @FUNCTION: cmake-utils_use_with
128			# @USAGE: <USE flag> [flag name]
129			# @DESCRIPTION:
130	philantrop	1.3	# Based on use_with. See ebuild(5).
131	betelgeuse	1.4	#
132	philantrop	1.3	# `cmake-utils_use_with foo FOO` echoes -DWITH_FOO=ON if foo is enabled
133			# and -DWITH_FOO=OFF if it is disabled.
134	scarabeus	1.20	cmake-utils_use_with() { _use_me_now WITH_ "$@" ; }
135	philantrop	1.1
136			# @FUNCTION: cmake-utils_use_enable
137			# @USAGE: <USE flag> [flag name]
138			# @DESCRIPTION:
139	philantrop	1.3	# Based on use_enable. See ebuild(5).
140	betelgeuse	1.4	#
141	philantrop	1.3	# `cmake-utils_use_enable foo FOO` echoes -DENABLE_FOO=ON if foo is enabled
142			# and -DENABLE_FOO=OFF if it is disabled.
143	scarabeus	1.20	cmake-utils_use_enable() { _use_me_now ENABLE_ "$@" ; }
144	philantrop	1.1
145	scarabeus	1.17	# @FUNCTION: cmake-utils_use_disable
146			# @USAGE: <USE flag> [flag name]
147			# @DESCRIPTION:
148			# Based on inversion of use_enable. See ebuild(5).
149			#
150			# `cmake-utils_use_enable foo FOO` echoes -DDISABLE_FOO=OFF if foo is enabled
151			# and -DDISABLE_FOO=ON if it is disabled.
152	scarabeus	1.20	cmake-utils_use_disable() { _use_me_now_inverted DISABLE_ "$@" ; }
153	scarabeus	1.17
154			# @FUNCTION: cmake-utils_use_no
155			# @USAGE: <USE flag> [flag name]
156			# @DESCRIPTION:
157			# Based on use_disable. See ebuild(5).
158			#
159			# `cmake-utils_use_no foo FOO` echoes -DNO_FOO=OFF if foo is enabled
160			# and -DNO_FOO=ON if it is disabled.
161	scarabeus	1.20	cmake-utils_use_no() { _use_me_now_inverted NO_ "$@" ; }
162	scarabeus	1.17
163	philantrop	1.2	# @FUNCTION: cmake-utils_use_want
164			# @USAGE: <USE flag> [flag name]
165			# @DESCRIPTION:
166	philantrop	1.3	# Based on use_enable. See ebuild(5).
167	betelgeuse	1.4	#
168	philantrop	1.3	# `cmake-utils_use_want foo FOO` echoes -DWANT_FOO=ON if foo is enabled
169			# and -DWANT_FOO=OFF if it is disabled.
170	scarabeus	1.20	cmake-utils_use_want() { _use_me_now WANT_ "$@" ; }
171	philantrop	1.2
172	scarabeus	1.17	# @FUNCTION: cmake-utils_use_build
173			# @USAGE: <USE flag> [flag name]
174			# @DESCRIPTION:
175			# Based on use_enable. See ebuild(5).
176			#
177			# `cmake-utils_use_build foo FOO` echoes -DBUILD_FOO=ON if foo is enabled
178			# and -DBUILD_FOO=OFF if it is disabled.
179	scarabeus	1.20	cmake-utils_use_build() { _use_me_now BUILD_ "$@" ; }
180	scarabeus	1.17
181			# @FUNCTION: cmake-utils_use_has
182			# @USAGE: <USE flag> [flag name]
183			# @DESCRIPTION:
184			# Based on use_enable. See ebuild(5).
185			#
186			# `cmake-utils_use_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled
187			# and -DHAVE_FOO=OFF if it is disabled.
188	scarabeus	1.20	cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; }
189	scarabeus	1.17
190	philantrop	1.3	# @FUNCTION: cmake-utils_has
191	scarabeus	1.17	# @DESCRIPTION:
192			# Deprecated, use cmake-utils_use_has, kept now for backcompat.
193	scarabeus	1.20	cmake-utils_has() { ewarn "QA notice: using deprecated ${FUNCNAME} call, use cmake-utils_use_has instead." ; _use_me_now HAVE_ "$@" ; }
194	scarabeus	1.17
195			# @FUNCTION: cmake-utils_use
196	philantrop	1.3	# @USAGE: <USE flag> [flag name]
197			# @DESCRIPTION:
198			# Based on use_enable. See ebuild(5).
199	betelgeuse	1.4	#
200	scarabeus	1.17	# `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled
201			# and -DFOO=OFF if it is disabled.
202			cmake-utils_use() { _use_me_now "" "$@" ; }
203
204			# Internal function for modifying hardcoded definitions.
205			# Removes dangerous definitionts that override Gentoo settings.
206			_modify-cmakelists() {
207			debug-print-function ${FUNCNAME} "$@"
208
209			# Comment out all set (<some_should_be_user_defined_variable> value)
210			# TODO Add QA checker - inform when variable being checked for below is set in CMakeLists.txt
211			find "${S}" -name CMakeLists.txt \
212			-exec sed -i -e '/^[[:space:]][sS][eE][tT][[:space:]]([[:space:]]CMAKE_BUILD_TYPE.)/{s/^/#IGNORE /g}' {} + \
213			-exec sed -i -e '/^[[:space:]][sS][eE][tT][[:space:]]([[:space:]]CMAKE_INSTALL_PREFIX.)/{s/^/#IGNORE /g}' {} + \
214			\|\| die "${LINENO}: failed to disable hardcoded settings"
215
216			# NOTE Append some useful summary here
217			echo '
218			MESSAGE(STATUS "<<< Gentoo configuration >>>
219			Build type: ${CMAKE_BUILD_TYPE}
220			Install path: ${CMAKE_INSTALL_PREFIX}\n")' >> CMakeLists.txt
221			}
222	philantrop	1.3
223	jmbsvicetto	1.9	# @FUNCTION: cmake-utils_src_configure
224	philantrop	1.1	# @DESCRIPTION:
225	jmbsvicetto	1.9	# General function for configuring with cmake. Default behaviour is to start an
226			# out-of-source build.
227			cmake-utils_src_configure() {
228	scarabeus	1.17	debug-print-function ${FUNCNAME} "$@"
229	philantrop	1.1
230	scarabeus	1.24	# check if CMakeLists.txt exist and if no then die
231			if [[ ! -e "${S}"/CMakeLists.txt ]] ; then
232			eerror "I was unable to locate CMakeLists.txt under:"
233			eerror "\"${S}/CMakeLists.txt\""
234			eerror "You should consider not inheriting the cmake eclass."
235			die "FATAL: Unable to find CMakeLists.txt"
236			fi
237
238	scarabeus	1.17	# Remove dangerous things.
239			_modify-cmakelists
240
241			# @SEE CMAKE_BUILD_TYPE
242			if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then
243			# Handle release builds
244			if ! has debug ${IUSE//+} \|\| ! use debug; then
245			append-cppflags -DNDEBUG
246			fi
247	philantrop	1.2	fi
248	scarabeus	1.17
249			# Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
250			local build_rules="${TMPDIR}"/gentoo_rules.cmake
251			cat > ${build_rules} << _EOF_
252			SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
253			SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
254			SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
255			SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE)
256			_EOF_
257
258			# Common configure parameters (overridable)
259			# NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable
260			# No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect.
261			local cmakeargs="
262			-DCMAKE_INSTALL_PREFIX=${PREFIX:-/usr}
263			${mycmakeargs}
264			-DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
265			-DCMAKE_INSTALL_DO_STRIP=OFF
266			-DCMAKE_USER_MAKE_RULES_OVERRIDE=${build_rules}"
267
268			# Common configure parameters (invariants)
269			local common_config="${TMPDIR}"/gentoo_common_config.cmake
270			local libdir=$(get_libdir)
271			cat > ${common_config} << _EOF_
272			SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
273			_EOF_
274			[[ -n ${CMAKE_NO_COLOR} ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> ${common_config}
275			cmakeargs="-C ${common_config} ${cmakeargs}"
276
277			_check_build_dir
278			mkdir -p "${CMAKE_BUILD_DIR}"
279			pushd "${CMAKE_BUILD_DIR}" > /dev/null
280			debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is $cmakeargs"
281			cmake ${cmakeargs} "${S}" \|\| die "cmake failed"
282
283			popd > /dev/null
284	jmbsvicetto	1.9	}
285
286			# @FUNCTION: cmake-utils_src_compile
287			# @DESCRIPTION:
288			# General function for compiling with cmake. Default behaviour is to check for
289	scarabeus	1.17	# EAPI and respectively to configure as well or just compile.
290	jmbsvicetto	1.9	cmake-utils_src_compile() {
291	scarabeus	1.17	debug-print-function ${FUNCNAME} "$@"
292	jmbsvicetto	1.9
293	scarabeus	1.17	has src_configure ${EXPF} \|\| cmake-utils_src_configure
294	philantrop	1.3	cmake-utils_src_make "$@"
295	philantrop	1.1	}
296
297			# @FUNCTION: cmake-utils_src_configurein
298			# @DESCRIPTION:
299	scarabeus	1.17	# Deprecated
300	philantrop	1.1	cmake-utils_src_configurein() {
301	scarabeus	1.18	ewarn "QA notice: using deprecated ${FUNCNAME} call, set CMAKE_IN_SOURCE_BUILD=1 instead."
302	scarabeus	1.17	cmake-utils_src_configure
303	philantrop	1.1	}
304
305			# @FUNCTION: cmake-utils_src_configureout
306			# @DESCRIPTION:
307	scarabeus	1.17	# Deprecated
308	philantrop	1.1	cmake-utils_src_configureout() {
309	scarabeus	1.18	ewarn "QA notice: using deprecated ${FUNCNAME} call, out of source build is enabled by default."
310	scarabeus	1.17	cmake-utils_src_configure
311	philantrop	1.1	}
312
313			# @FUNCTION: cmake-utils_src_make
314			# @DESCRIPTION:
315			# Function for building the package. Automatically detects the build type.
316	philantrop	1.3	# All arguments are passed to emake:
317	philantrop	1.1	cmake-utils_src_make() {
318	scarabeus	1.17	debug-print-function ${FUNCNAME} "$@"
319	philantrop	1.1
320	scarabeus	1.17	_check_build_dir
321			pushd "${CMAKE_BUILD_DIR}" > /dev/null
322	scarabeus	1.25	# first check if Makefile exist otherwise die
323			[[ -e Makefile ]] \|\| die "Makefile not found. Error during configure stage."
324	scarabeus	1.17	if [[ -n ${CMAKE_VERBOSE} ]]; then
325	philantrop	1.3	emake VERBOSE=1 "$@" \|\| die "Make failed!"
326	philantrop	1.1	else
327	philantrop	1.3	emake "$@" \|\| die "Make failed!"
328	philantrop	1.2	fi
329	scarabeus	1.17	popd > /dev/null
330	philantrop	1.1	}
331
332			# @FUNCTION: cmake-utils_src_install
333			# @DESCRIPTION:
334			# Function for installing the package. Automatically detects the build type.
335			cmake-utils_src_install() {
336	scarabeus	1.17	debug-print-function ${FUNCNAME} "$@"
337	philantrop	1.1
338	scarabeus	1.17	_check_build_dir
339			pushd "${CMAKE_BUILD_DIR}" > /dev/null
340	philantrop	1.1	emake install DESTDIR="${D}" \|\| die "Make install failed"
341	scarabeus	1.17	popd > /dev/null
342	zlin	1.5
343			# Manual document installation
344	scarabeus	1.17	[[ -n "${DOCS}" ]] && { dodoc ${DOCS} \|\| die "dodoc failed" ; }
345			[[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} \|\| die "dohtml failed" ; }
346	philantrop	1.1	}
347
348			# @FUNCTION: cmake-utils_src_test
349			# @DESCRIPTION:
350			# Function for testing the package. Automatically detects the build type.
351			cmake-utils_src_test() {
352	scarabeus	1.17	debug-print-function ${FUNCNAME} "$@"
353	philantrop	1.1
354	scarabeus	1.17	_check_build_dir
355			pushd "${CMAKE_BUILD_DIR}" > /dev/null
356	philantrop	1.1	# Standard implementation of src_test
357			if emake -j1 check -n &> /dev/null; then
358			einfo ">>> Test phase [check]: ${CATEGORY}/${PF}"
359			if ! emake -j1 check; then
360			die "Make check failed. See above for details."
361			fi
362			elif emake -j1 test -n &> /dev/null; then
363			einfo ">>> Test phase [test]: ${CATEGORY}/${PF}"
364			if ! emake -j1 test; then
365			die "Make test failed. See above for details."
366			fi
367			else
368			einfo ">>> Test phase [none]: ${CATEGORY}/${PF}"
369			fi
370	scarabeus	1.17	popd > /dev/null
371	philantrop	1.1	}