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.42 2010/01/10 22:17:02 scarabeus Exp $

# @ECLASS: cmake-utils.eclass
# @MAINTAINER:
# kde@gentoo.org
#
# @CODE
# Tomáš Chvátal <scarabeus@gentoo.org>
# Maciej Mrozowski <reavertm@gmail.com>
# (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
        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-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_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 definitions that override Gentoo settings.
_modify-cmakelists() {
        debug-print-function ${FUNCNAME} "$@"

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

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

                MESSAGE(STATUS "<<< Gentoo configuration >>>
                Build type: \${CMAKE_BUILD_TYPE}
                Install path: \${CMAKE_INSTALL_PREFIX}\n")
        _EOF_
}

# @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=${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)
                        SET (CMAKE_BUILD_WITH_INSTALL_RPATH ON CACHE BOOL "" 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)
        _EOF_
        [[ -n ${NOCOLOR} ]] || echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}"

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

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

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

        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
}

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