/[gentoo-x86]/eclass/cmake-utils.eclass
Gentoo

Diff of /eclass/cmake-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.33 Revision 1.51
1# Copyright 1999-2009 Gentoo Foundation 1# Copyright 1999-2010 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.33 2009/10/27 14:30:35 scarabeus Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.51 2010/04/30 23:58:47 abcd Exp $
4 4
5# @ECLASS: cmake-utils.eclass 5# @ECLASS: cmake-utils.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# kde@gentoo.org 7# kde@gentoo.org
8# 8#
9# @CODE 9# @CODE
10# Tomáš Chvátal <scarabeus@gentoo.org> 10# Tomáš Chvátal <scarabeus@gentoo.org>
11# Maciej Mrozowski <reavertm@poczta.fm> 11# Maciej Mrozowski <reavertm@gmail.com>
12# (undisclosed contributors) 12# (undisclosed contributors)
13# Original author: Zephyrus (zephyrus@mirach.it) 13# Original author: Zephyrus (zephyrus@mirach.it)
14# @CODE 14# @CODE
15# @BLURB: common ebuild functions for cmake-based packages 15# @BLURB: common ebuild functions for cmake-based packages
16# @DESCRIPTION: 16# @DESCRIPTION:
25# Specify if cmake-utils eclass should depend on cmake optionaly or not. 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. 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 27# Valid values are: always [default], optional (where the value is the useflag
28# used for optionality) 28# used for optionality)
29WANT_CMAKE="${WANT_CMAKE:-always}" 29WANT_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
34CMAKE_MIN_VERSION="${CMAKE_MIN_VERSION:-2.6.2-r1}"
35
30CMAKEDEPEND="" 36CMAKEDEPEND=""
31case ${WANT_CMAKE} in 37case ${WANT_CMAKE} in
32 always) 38 always)
33 ;; 39 ;;
34 *) 40 *)
35 IUSE+=" ${WANT_CMAKE}" 41 IUSE+=" ${WANT_CMAKE}"
36 CMAKEDEPEND+="${WANT_CMAKE}? ( " 42 CMAKEDEPEND+="${WANT_CMAKE}? ( "
37 ;; 43 ;;
38esac 44esac
39inherit toolchain-funcs multilib flag-o-matic base 45inherit toolchain-funcs multilib flag-o-matic base
40 46
41CMAKE_EXPF="src_compile src_test src_install" 47CMAKE_EXPF="src_compile src_test src_install"
42case ${EAPI:-0} in 48case ${EAPI:-0} in
43 2) CMAKE_EXPF+=" src_configure" ;; 49 3|2) CMAKE_EXPF+=" src_configure" ;;
44 1|0) ;; 50 1|0) ;;
45 *) die "Unknown EAPI, Bug eclass maintainers." ;; 51 *) die "Unknown EAPI, Bug eclass maintainers." ;;
46esac 52esac
47EXPORT_FUNCTIONS ${CMAKE_EXPF} 53EXPORT_FUNCTIONS ${CMAKE_EXPF}
48 54
49: ${DESCRIPTION:="Based on the ${ECLASS} eclass"} 55: ${DESCRIPTION:="Based on the ${ECLASS} eclass"}
50 56
51if [[ ${PN} != cmake ]]; then 57if [[ ${PN} != cmake ]]; then
52 CMAKEDEPEND+=">=dev-util/cmake-2.6.2-r1" 58 CMAKEDEPEND+=">=dev-util/cmake-${CMAKE_MIN_VERSION}"
53fi 59fi
54 60
55CMAKEDEPEND+="userland_GNU? ( >=sys-apps/findutils-4.4.0 )" 61CMAKEDEPEND+=" userland_GNU? ( >=sys-apps/findutils-4.4.0 )"
56 62
57[[ ${WANT_CMAKE} = always ]] || CMAKEDEPEND+=" )" 63[[ ${WANT_CMAKE} = always ]] || CMAKEDEPEND+=" )"
58 64
59DEPEND="${CMAKEDEPEND}" 65DEPEND="${CMAKEDEPEND}"
60unset CMAKEDEPEND 66unset CMAKEDEPEND
110# Use -DCMAKE_INSTALL_PREFIX=... CMake variable instead. 116# Use -DCMAKE_INSTALL_PREFIX=... CMake variable instead.
111 117
112# @ECLASS-VARIABLE: CMAKE_IN_SOURCE_BUILD 118# @ECLASS-VARIABLE: CMAKE_IN_SOURCE_BUILD
113# @DESCRIPTION: 119# @DESCRIPTION:
114# Set to enable in-source build. 120# Set to enable in-source build.
115
116# @ECLASS-VARIABLE: CMAKE_NO_COLOR
117# @DESCRIPTION:
118# Set to disable cmake output coloring.
119 121
120# @ECLASS-VARIABLE: CMAKE_VERBOSE 122# @ECLASS-VARIABLE: CMAKE_VERBOSE
121# @DESCRIPTION: 123# @DESCRIPTION:
122# Set to enable verbose messages during compilation. 124# Set to enable verbose messages during compilation.
123 125
146 # @DESCRIPTION: 148 # @DESCRIPTION:
147 # Specify the build directory where all cmake processed 149 # Specify the build directory where all cmake processed
148 # files should be located. 150 # files should be located.
149 # 151 #
150 # For installing binary doins "${CMAKE_BUILD_DIR}/${PN}" 152 # For installing binary doins "${CMAKE_BUILD_DIR}/${PN}"
151 if [[ -n "${CMAKE_IN_SOURCE_BUILD}" ]]; then 153 if [[ -n ${CMAKE_IN_SOURCE_BUILD} ]]; then
152 # we build in source dir 154 # we build in source dir
153 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}" 155 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}"
154 elif [[ ${CMAKE_USE_DIR} = ${WORKDIR} ]]; then 156 elif [[ ${CMAKE_USE_DIR} = ${WORKDIR} ]]; then
155 # out of tree build, but with $S=$WORKDIR, see bug #273949 for reason. 157 # out of tree build, but with $S=$WORKDIR, see bug #273949 for reason.
156 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}/build" 158 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}/build"
157 else 159 else
158 # regular out of tree build 160 # regular out of tree build
159 [[ ${1} = init || -d ${CMAKE_USE_DIR}_build ]] && SUF="_build" || SUF="" 161 [[ ${1} = init || -d ${CMAKE_USE_DIR}_build ]] && SUF="_build" || SUF=""
160 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}${SUF}" 162 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}${SUF}"
161
162 fi 163 fi
163 echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\"" 164 echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\""
164} 165}
165# @FUNCTION: cmake-utils_use_with 166# @FUNCTION: cmake-utils_use_with
166# @USAGE: <USE flag> [flag name] 167# @USAGE: <USE flag> [flag name]
233# `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled 234# `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled
234# and -DFOO=OFF if it is disabled. 235# and -DFOO=OFF if it is disabled.
235cmake-utils_use() { _use_me_now "" "$@" ; } 236cmake-utils_use() { _use_me_now "" "$@" ; }
236 237
237# Internal function for modifying hardcoded definitions. 238# Internal function for modifying hardcoded definitions.
238# Removes dangerous definitionts that override Gentoo settings. 239# Removes dangerous definitions that override Gentoo settings.
239_modify-cmakelists() { 240_modify-cmakelists() {
240 debug-print-function ${FUNCNAME} "$@" 241 debug-print-function ${FUNCNAME} "$@"
241 242
242 # Comment out all set (<some_should_be_user_defined_variable> value) 243 # Comment out all set (<some_should_be_user_defined_variable> value)
243 # TODO Add QA checker - inform when variable being checked for below is set in CMakeLists.txt 244 # TODO Add QA checker - inform when variable being checked for below is set in CMakeLists.txt
245 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_BUILD_TYPE.*)/{s/^/#IGNORE /g}' {} + \ 246 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_BUILD_TYPE.*)/{s/^/#IGNORE /g}' {} + \
246 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \ 247 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \
247 || die "${LINENO}: failed to disable hardcoded settings" 248 || die "${LINENO}: failed to disable hardcoded settings"
248 249
249 # NOTE Append some useful summary here 250 # NOTE Append some useful summary here
250 echo ' 251 cat >> CMakeLists.txt <<- _EOF_
252
251MESSAGE(STATUS "<<< Gentoo configuration >>> 253 MESSAGE(STATUS "<<< Gentoo configuration >>>
252Build type: ${CMAKE_BUILD_TYPE} 254 Build type \${CMAKE_BUILD_TYPE}
253Install path: ${CMAKE_INSTALL_PREFIX}\n")' >> CMakeLists.txt 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 _EOF_
254} 264}
255 265
256# @FUNCTION: enable_cmake-utils_src_configure 266# @FUNCTION: enable_cmake-utils_src_configure
257# @DESCRIPTION: 267# @DESCRIPTION:
258# General function for configuring with cmake. Default behaviour is to start an 268# General function for configuring with cmake. Default behaviour is to start an
261 debug-print-function ${FUNCNAME} "$@" 271 debug-print-function ${FUNCNAME} "$@"
262 272
263 _check_build_dir init 273 _check_build_dir init
264 274
265 # check if CMakeLists.txt exist and if no then die 275 # check if CMakeLists.txt exist and if no then die
266 if [[ ! -e "${CMAKE_USE_DIR}"/CMakeLists.txt ]] ; then 276 if [[ ! -e ${CMAKE_USE_DIR}/CMakeLists.txt ]] ; then
267 eerror "I was unable to locate CMakeLists.txt under:" 277 eerror "Unable to locate CMakeLists.txt under:"
268 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\"" 278 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\""
269 eerror "You should consider not inheriting the cmake eclass." 279 eerror "Consider not inheriting the cmake eclass."
270 die "FATAL: Unable to find CMakeLists.txt" 280 die "FATAL: Unable to find CMakeLists.txt"
271 fi 281 fi
272 282
273 # Remove dangerous things. 283 # Remove dangerous things.
274 _modify-cmakelists 284 _modify-cmakelists
283 append-cppflags -DNDEBUG 293 append-cppflags -DNDEBUG
284 fi 294 fi
285 fi 295 fi
286 296
287 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS) 297 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
288 local build_rules="${TMPDIR}"/gentoo_rules.cmake 298 local build_rules=${T}/gentoo_rules.cmake
289cat > ${build_rules} << _EOF_ 299 cat > "${build_rules}" <<- _EOF_
290SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE) 300 SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
291SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE) 301 SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
292SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE) 302 SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
293SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE) 303 SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE)
294_EOF_ 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 SET (CMAKE_INSTALL_LIBDIR ${libdir} CACHE PATH "Output directory for libraries")
324 _EOF_
325 [[ -n ${NOCOLOR} ]] || echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}"
326
327 # Convert mycmakeargs to an array, for backwards compatibility
328 # Make the array a local variable since <=portage-2.1.6.x does not
329 # support global arrays (see bug #297255).
330 if [[ $(declare -p mycmakeargs 2>&-) != "declare -a mycmakeargs="* ]]; then
331 local mycmakeargs_local=(${mycmakeargs})
332 else
333 local mycmakeargs_local=("${mycmakeargs[@]}")
334 fi
335
336 has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=
295 337
296 # Common configure parameters (overridable) 338 # Common configure parameters (overridable)
297 # NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable 339 # NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable
298 # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect. 340 # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect.
299 local cmakeargs=" 341 local cmakeargs=(
342 -C "${common_config}"
300 -DCMAKE_INSTALL_PREFIX=${PREFIX:-/usr} 343 -DCMAKE_INSTALL_PREFIX="${EPREFIX}${PREFIX:-/usr}"
301 ${mycmakeargs} 344 "${mycmakeargs_local[@]}"
302 -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} 345 -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}"
303 -DCMAKE_INSTALL_DO_STRIP=OFF 346 -DCMAKE_INSTALL_DO_STRIP=OFF
304 -DCMAKE_USER_MAKE_RULES_OVERRIDE=${build_rules}" 347 -DCMAKE_USER_MAKE_RULES_OVERRIDE="${build_rules}"
305 348 "${MYCMAKEARGS}"
306 # Common configure parameters (invariants) 349 )
307 local common_config="${TMPDIR}"/gentoo_common_config.cmake
308 local libdir=$(get_libdir)
309cat > ${common_config} << _EOF_
310SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
311_EOF_
312 [[ -n ${CMAKE_NO_COLOR} ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> ${common_config}
313 cmakeargs="-C ${common_config} ${cmakeargs}"
314 350
315 mkdir -p "${CMAKE_BUILD_DIR}" 351 mkdir -p "${CMAKE_BUILD_DIR}"
316 pushd "${CMAKE_BUILD_DIR}" > /dev/null 352 pushd "${CMAKE_BUILD_DIR}" > /dev/null
317 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is $cmakeargs" 353 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is ${mycmakeargs_local[*]}"
318 echo cmake ${cmakeargs} "${CMAKE_USE_DIR}" 354 echo cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}"
319 cmake ${cmakeargs} "${CMAKE_USE_DIR}" || die "cmake failed" 355 cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" || die "cmake failed"
320 356
321 popd > /dev/null 357 popd > /dev/null
322} 358}
323 359
324# @FUNCTION: enable_cmake-utils_src_compile 360# @FUNCTION: enable_cmake-utils_src_compile
333} 369}
334 370
335# @FUNCTION: cmake-utils_src_make 371# @FUNCTION: cmake-utils_src_make
336# @DESCRIPTION: 372# @DESCRIPTION:
337# Function for building the package. Automatically detects the build type. 373# Function for building the package. Automatically detects the build type.
338# All arguments are passed to emake: 374# All arguments are passed to emake
339cmake-utils_src_make() { 375cmake-utils_src_make() {
340 debug-print-function ${FUNCNAME} "$@" 376 debug-print-function ${FUNCNAME} "$@"
341 377
342 _check_build_dir 378 _check_build_dir
343 pushd "${CMAKE_BUILD_DIR}" &> /dev/null 379 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
396# @FUNCTION: cmake-utils_src_configure 432# @FUNCTION: cmake-utils_src_configure
397# @DESCRIPTION: 433# @DESCRIPTION:
398# Wrapper for detection if we want to run enable_ prefixed function with same name 434# Wrapper for detection if we want to run enable_ prefixed function with same name
399# unconditionaly or only when some useflag is enabled. 435# unconditionaly or only when some useflag is enabled.
400cmake-utils_src_configure() { 436cmake-utils_src_configure() {
401 _execute_optionaly "src_configure" 437 _execute_optionaly "src_configure" "$@"
402} 438}
403 439
404# @FUNCTION: cmake-utils_src_compile 440# @FUNCTION: cmake-utils_src_compile
405# @DESCRIPTION: 441# @DESCRIPTION:
406# Wrapper for detection if we want to run enable_ prefixed function with same name 442# Wrapper for detection if we want to run enable_ prefixed function with same name
407# unconditionaly or only when some useflag is enabled. 443# unconditionaly or only when some useflag is enabled.
408cmake-utils_src_compile() { 444cmake-utils_src_compile() {
409 _execute_optionaly "src_compile" 445 _execute_optionaly "src_compile" "$@"
410} 446}
411 447
412# @FUNCTION: cmake-utils_src_install 448# @FUNCTION: cmake-utils_src_install
413# @DESCRIPTION: 449# @DESCRIPTION:
414# Wrapper for detection if we want to run enable_ prefixed function with same name 450# Wrapper for detection if we want to run enable_ prefixed function with same name
415# unconditionaly or only when some useflag is enabled. 451# unconditionaly or only when some useflag is enabled.
416cmake-utils_src_install() { 452cmake-utils_src_install() {
417 _execute_optionaly "src_install" 453 _execute_optionaly "src_install" "$@"
418} 454}
419 455
420# @FUNCTION: cmake-utils_src_test 456# @FUNCTION: cmake-utils_src_test
421# @DESCRIPTION: 457# @DESCRIPTION:
422# Wrapper for detection if we want to run enable_ prefixed function with same name 458# Wrapper for detection if we want to run enable_ prefixed function with same name
423# unconditionaly or only when some useflag is enabled. 459# unconditionaly or only when some useflag is enabled.
424cmake-utils_src_test() { 460cmake-utils_src_test() {
425 _execute_optionaly "src_test" 461 _execute_optionaly "src_test" "$@"
426} 462}
427 463
428 464
429_execute_optionaly() { 465_execute_optionaly() {
430 local phase="$1" 466 local phase="$1" ; shift
431 if [[ ${WANT_CMAKE} = always ]]; then 467 if [[ ${WANT_CMAKE} = always ]]; then
432 enable_cmake-utils_${phase} 468 enable_cmake-utils_${phase} "$@"
433 else 469 else
434 use ${WANT_CMAKE} && enable_cmake-utils_${phase} 470 use ${WANT_CMAKE} && enable_cmake-utils_${phase} "$@"
435 fi 471 fi
436} 472}

Legend:
Removed from v.1.33  
changed lines
  Added in v.1.51

  ViewVC Help
Powered by ViewVC 1.1.20