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.54 2010/06/26 17:55:59 reavertm 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: CMAKE_BUILD_DIR
# @DESCRIPTION:
# Build directory where all cmake processed files should be generated.
# For in-source build it's fixed to ${CMAKE_USE_DIR}.
# For out-of-source build it can be overriden, by default it uses
# ${WORKDIR}/${P}_build.

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

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

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

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

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

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