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.50 2010/04/30 23:41:11 abcd 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}"

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

# @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 "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_
        [[ -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}"
                "${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
}

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