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.25 2009/04/11 19:44:43 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() {
        # @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}}

        # in/out source build
        if [[ -n "${CMAKE_IN_SOURCE_BUILD}" ]]; then
                CMAKE_BUILD_DIR="${CMAKE_USE_DIR}"
        else
                CMAKE_BUILD_DIR="${CMAKE_USE_DIR}_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 "${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
        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_build_dir

        # check if CMakeLists.txt exist and if no then die
        if [[ ! -e "${CMAKE_USE_DIR}"/CMakeLists.txt ]] ; then
                eerror "I was unable to locate CMakeLists.txt under:"
                eerror "\"${CMAKE_USE_DIR}/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}"

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