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.32 2009/10/27 14:16:49 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.

# @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}"
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
        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-2.6.2-r1"
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: 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}}

        # @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 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: enable_cmake-utils_src_configure
# @DESCRIPTION:
# General function for configuring with cmake. Default behaviour is to start an
# out-of-source build.
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 "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

        # 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="${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"
        echo cmake ${cmakeargs} "${CMAKE_USE_DIR}"
        cmake ${cmakeargs} "${CMAKE_USE_DIR}" || die "cmake failed"

        popd > /dev/null
}

# @FUNCTION: enable_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.
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
}

# @FUNCTION: enable_cmake-utils_src_install
# @DESCRIPTION:
# Function for installing the package. Automatically detects the build type.
enable_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: enable_cmake-utils_src_test
# @DESCRIPTION:
# Function for testing the package. Automatically detects the build type.
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
}

## Wrappers for calls bellow this line
# @FUNCTION: cmake-utils_src_configure
# @DESCRIPTION:
# Wrapper for detection if we want to run enable_ prefixed function with same name
# unconditionaly or only when some useflag is enabled.
cmake-utils_src_configure() {
        _execute_optionaly "src_configure"
}

# @FUNCTION: cmake-utils_src_compile
# @DESCRIPTION:
# Wrapper for detection if we want to run enable_ prefixed function with same name
# unconditionaly or only when some useflag is enabled.
cmake-utils_src_compile() {
        _execute_optionaly "src_compile"
}

# @FUNCTION: cmake-utils_src_install
# @DESCRIPTION:
# Wrapper for detection if we want to run enable_ prefixed function with same name
# unconditionaly or only when some useflag is enabled.
cmake-utils_src_install() {
        _execute_optionaly "src_install"
}

# @FUNCTION: cmake-utils_src_test
# @DESCRIPTION:
# Wrapper for detection if we want to run enable_ prefixed function with same name
# unconditionaly or only when some useflag is enabled.
cmake-utils_src_test() {
        _execute_optionaly "src_test"
}


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