/[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.56 Revision 1.78
1# Copyright 1999-2010 Gentoo Foundation 1# Copyright 1999-2012 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.56 2010/07/14 15:48:43 scarabeus Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.78 2012/04/16 10:28:47 scarabeus 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# @AUTHOR:
9# @CODE
10# Tomáš Chvátal <scarabeus@gentoo.org> 9# Tomáš Chvátal <scarabeus@gentoo.org>
11# Maciej Mrozowski <reavertm@gentoo.org> 10# Maciej Mrozowski <reavertm@gentoo.org>
12# (undisclosed contributors) 11# (undisclosed contributors)
13# Original author: Zephyrus (zephyrus@mirach.it) 12# Original author: Zephyrus (zephyrus@mirach.it)
14# @CODE
15# @BLURB: common ebuild functions for cmake-based packages 13# @BLURB: common ebuild functions for cmake-based packages
16# @DESCRIPTION: 14# @DESCRIPTION:
17# The cmake-utils eclass is base.eclass(5) wrapper that makes creating ebuilds for 15# The cmake-utils eclass is base.eclass(5) wrapper that makes creating ebuilds for
18# cmake-based packages much easier. 16# cmake-based packages much easier.
19# It provides all inherited features (DOCS, HTML_DOCS, PATCHES) along with out-of-source 17# It provides all inherited features (DOCS, HTML_DOCS, PATCHES) along with out-of-source
28# used for optionality) 26# used for optionality)
29WANT_CMAKE="${WANT_CMAKE:-always}" 27WANT_CMAKE="${WANT_CMAKE:-always}"
30 28
31# @ECLASS-VARIABLE: CMAKE_MIN_VERSION 29# @ECLASS-VARIABLE: CMAKE_MIN_VERSION
32# @DESCRIPTION: 30# @DESCRIPTION:
33# Specify the minimum allowable version of cmake. Defaults to 2.6.2-r1 31# Specify the minimum required CMake version. Default is 2.8.4
34CMAKE_MIN_VERSION="${CMAKE_MIN_VERSION:-2.6.2-r1}" 32CMAKE_MIN_VERSION="${CMAKE_MIN_VERSION:-2.8.4}"
33
34# @ECLASS-VARIABLE: CMAKE_REMOVE_MODULES_LIST
35# @DESCRIPTION:
36# Space-separated list of CMake modules that will be removed in $S during src_prepare,
37# in order to force packages to use the system version.
38CMAKE_REMOVE_MODULES_LIST="${CMAKE_REMOVE_MODULES_LIST:-FindBLAS FindLAPACK}"
39
40# @ECLASS-VARIABLE: CMAKE_REMOVE_MODULES
41# @DESCRIPTION:
42# Do we want to remove anything? yes or whatever else for no
43CMAKE_REMOVE_MODULES="${CMAKE_REMOVE_MODULES:-yes}"
35 44
36CMAKEDEPEND="" 45CMAKEDEPEND=""
37case ${WANT_CMAKE} in 46case ${WANT_CMAKE} in
38 always) 47 always)
39 ;; 48 ;;
44esac 53esac
45inherit toolchain-funcs multilib flag-o-matic base 54inherit toolchain-funcs multilib flag-o-matic base
46 55
47CMAKE_EXPF="src_compile src_test src_install" 56CMAKE_EXPF="src_compile src_test src_install"
48case ${EAPI:-0} in 57case ${EAPI:-0} in
49 3|2) CMAKE_EXPF+=" src_configure" ;; 58 4|3|2) CMAKE_EXPF+=" src_configure" ;;
50 1|0) ;; 59 1|0) ;;
51 *) die "Unknown EAPI, Bug eclass maintainers." ;; 60 *) die "Unknown EAPI, Bug eclass maintainers." ;;
52esac 61esac
53EXPORT_FUNCTIONS ${CMAKE_EXPF} 62EXPORT_FUNCTIONS ${CMAKE_EXPF}
54 63
55: ${DESCRIPTION:="Based on the ${ECLASS} eclass"} 64: ${DESCRIPTION:="Based on the ${ECLASS} eclass"}
56 65
57if [[ ${PN} != cmake ]]; then 66if [[ ${PN} != cmake ]]; then
58 CMAKEDEPEND+=">=dev-util/cmake-${CMAKE_MIN_VERSION}" 67 CMAKEDEPEND+=" >=dev-util/cmake-${CMAKE_MIN_VERSION}"
59fi 68fi
60 69
61CMAKEDEPEND+=" userland_GNU? ( >=sys-apps/findutils-4.4.0 )" 70CMAKEDEPEND+=" userland_GNU? ( >=sys-apps/findutils-4.4.0 )"
62 71
63[[ ${WANT_CMAKE} = always ]] || CMAKEDEPEND+=" )" 72[[ ${WANT_CMAKE} = always ]] || CMAKEDEPEND+=" )"
136# @DESCRIPTION: 145# @DESCRIPTION:
137# Eclass respects PREFIX variable, though it's not recommended way to set 146# Eclass respects PREFIX variable, though it's not recommended way to set
138# install/lib/bin prefixes. 147# install/lib/bin prefixes.
139# Use -DCMAKE_INSTALL_PREFIX=... CMake variable instead. 148# Use -DCMAKE_INSTALL_PREFIX=... CMake variable instead.
140 149
150# @ECLASS-VARIABLE: CMAKE_BINARY
151# @DESCRIPTION:
152# Eclass can use different cmake binary than the one provided in by system.
153: ${CMAKE_BINARY:=cmake}
154
141# Determine using IN or OUT source build 155# Determine using IN or OUT source build
142_check_build_dir() { 156_check_build_dir() {
143 : ${CMAKE_USE_DIR:=${S}} 157 : ${CMAKE_USE_DIR:=${S}}
144 if [[ -n ${CMAKE_IN_SOURCE_BUILD} ]]; then 158 if [[ -n ${CMAKE_IN_SOURCE_BUILD} ]]; then
145 # we build in source dir 159 # we build in source dir
146 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}" 160 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 161 else
151 # regular out of tree build 162 : ${CMAKE_BUILD_DIR:=${WORKDIR}/${P}_build}
152 [[ ${1} = init || -d ${CMAKE_USE_DIR}_build ]] && SUF="_build" || SUF=""
153 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}${SUF}"
154 fi 163 fi
164 mkdir -p "${CMAKE_BUILD_DIR}"
155 echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\"" 165 echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\""
156} 166}
157# @FUNCTION: cmake-utils_use_with 167# @FUNCTION: cmake-utils_use_with
158# @USAGE: <USE flag> [flag name] 168# @USAGE: <USE flag> [flag name]
159# @DESCRIPTION: 169# @DESCRIPTION:
237 247
238# Internal function for modifying hardcoded definitions. 248# Internal function for modifying hardcoded definitions.
239# Removes dangerous definitions that override Gentoo settings. 249# Removes dangerous definitions that override Gentoo settings.
240_modify-cmakelists() { 250_modify-cmakelists() {
241 debug-print-function ${FUNCNAME} "$@" 251 debug-print-function ${FUNCNAME} "$@"
252
253 # Only edit the files once
254 grep -qs "<<< Gentoo configuration >>>" CMakeLists.txt && return 0
242 255
243 # Comment out all set (<some_should_be_user_defined_variable> value) 256 # 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 257 # TODO Add QA checker - inform when variable being checked for below is set in CMakeLists.txt
245 find "${CMAKE_USE_DIR}" -name CMakeLists.txt \ 258 find "${CMAKE_USE_DIR}" -name CMakeLists.txt \
246 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_BUILD_TYPE.*)/{s/^/#IGNORE /g}' {} + \ 259 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_BUILD_TYPE.*)/{s/^/#IGNORE /g}' {} + \
248 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \ 261 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \
249 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_VERBOSE_MAKEFILE.*)/{s/^/#IGNORE /g}' {} + \ 262 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_VERBOSE_MAKEFILE.*)/{s/^/#IGNORE /g}' {} + \
250 || die "${LINENO}: failed to disable hardcoded settings" 263 || die "${LINENO}: failed to disable hardcoded settings"
251 264
252 # NOTE Append some useful summary here 265 # NOTE Append some useful summary here
253 cat >> CMakeLists.txt <<- _EOF_ 266 cat >> "${CMAKE_USE_DIR}"/CMakeLists.txt <<- _EOF_
254 267
255 MESSAGE(STATUS "<<< Gentoo configuration >>> 268 MESSAGE(STATUS "<<< Gentoo configuration >>>
256 Build type \${CMAKE_BUILD_TYPE} 269 Build type \${CMAKE_BUILD_TYPE}
257 Install path \${CMAKE_INSTALL_PREFIX} 270 Install path \${CMAKE_INSTALL_PREFIX}
258 Compiler flags: 271 Compiler flags:
266} 279}
267 280
268enable_cmake-utils_src_configure() { 281enable_cmake-utils_src_configure() {
269 debug-print-function ${FUNCNAME} "$@" 282 debug-print-function ${FUNCNAME} "$@"
270 283
284 [[ "${CMAKE_REMOVE_MODULES}" == "yes" ]] && {
285 local name
286 for name in ${CMAKE_REMOVE_MODULES_LIST} ; do
287 find "${S}" -name ${name}.cmake -exec rm -v {} +
288 done
289 }
290
271 _check_build_dir init 291 _check_build_dir
272 292
273 # check if CMakeLists.txt exist and if no then die 293 # check if CMakeLists.txt exist and if no then die
274 if [[ ! -e ${CMAKE_USE_DIR}/CMakeLists.txt ]] ; then 294 if [[ ! -e ${CMAKE_USE_DIR}/CMakeLists.txt ]] ; then
275 eerror "Unable to locate CMakeLists.txt under:" 295 eerror "Unable to locate CMakeLists.txt under:"
276 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\"" 296 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\""
291 append-cppflags -DNDEBUG 311 append-cppflags -DNDEBUG
292 fi 312 fi
293 fi 313 fi
294 314
295 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS) 315 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
296 local build_rules=${T}/gentoo_rules.cmake 316 local build_rules=${CMAKE_BUILD_DIR}/gentoo_rules.cmake
297 cat > "${build_rules}" <<- _EOF_ 317 cat > "${build_rules}" <<- _EOF_
298 SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE) 318 SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
299 SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE) 319 SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
300 SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE) 320 SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
301 SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE) 321 SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE)
302 _EOF_ 322 _EOF_
303 323
304 if use prefix; then 324 has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=
325
326 if [[ ${EPREFIX} ]]; then
305 cat >> "${build_rules}" <<- _EOF_ 327 cat >> "${build_rules}" <<- _EOF_
306 # in Prefix we need rpath and must ensure cmake gets our default linker path 328 # in Prefix we need rpath and must ensure cmake gets our default linker path
307 # right ... except for Darwin hosts 329 # right ... except for Darwin hosts
308 IF (NOT APPLE) 330 IF (NOT APPLE)
309 SET (CMAKE_SKIP_RPATH OFF CACHE BOOL "" FORCE) 331 SET (CMAKE_SKIP_RPATH OFF CACHE BOOL "" FORCE)
310 SET (CMAKE_PLATFORM_REQUIRED_RUNTIME_PATH "${EPREFIX}/usr/${CHOST}/lib/gcc;${EPREFIX}/usr/${CHOST}/lib;${EPREFIX}/usr/$(get_libdir);${EPREFIX}/$(get_libdir)" 332 SET (CMAKE_PLATFORM_REQUIRED_RUNTIME_PATH "${EPREFIX}/usr/${CHOST}/lib/gcc;${EPREFIX}/usr/${CHOST}/lib;${EPREFIX}/usr/$(get_libdir);${EPREFIX}/$(get_libdir)"
311 CACHE STRING "" FORCE) 333 CACHE STRING "" FORCE)
334
335 ELSE ()
336
337 SET(CMAKE_PREFIX_PATH "${EPREFIX}${PREFIX:-/usr}" CACHE STRING ""FORCE)
338 SET(CMAKE_SKIP_BUILD_RPATH OFF CACHE BOOL "" FORCE)
339 SET(CMAKE_SKIP_RPATH OFF CACHE BOOL "" FORCE)
340 SET(CMAKE_BUILD_WITH_INSTALL_RPATH TRUE CACHE BOOL "")
341 SET(CMAKE_INSTALL_RPATH "${EPREFIX}${PREFIX:-/usr}/lib;${EPREFIX}/usr/${CHOST}/lib/gcc;${EPREFIX}/usr/${CHOST}/lib;${EPREFIX}/usr/$(get_libdir);${EPREFIX}/$(get_libdir)" CACHE STRING "" FORCE)
342 SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE CACHE BOOL "" FORCE)
343 SET(CMAKE_INSTALL_NAME_DIR "${EPREFIX}${PREFIX:-/usr}/lib" CACHE STRING "" FORCE)
344
312 ENDIF (NOT APPLE) 345 ENDIF (NOT APPLE)
313 _EOF_ 346 _EOF_
314 fi 347 fi
315 348
316 # Common configure parameters (invariants) 349 # Common configure parameters (invariants)
317 local common_config=${T}/gentoo_common_config.cmake 350 local common_config=${CMAKE_BUILD_DIR}/gentoo_common_config.cmake
318 local libdir=$(get_libdir) 351 local libdir=$(get_libdir)
319 cat > "${common_config}" <<- _EOF_ 352 cat > "${common_config}" <<- _EOF_
320 SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE) 353 SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
321 SET (CMAKE_INSTALL_LIBDIR ${libdir} CACHE PATH "Output directory for libraries") 354 SET (CMAKE_INSTALL_LIBDIR ${libdir} CACHE PATH "Output directory for libraries")
322 _EOF_ 355 _EOF_
329 local mycmakeargs_local=(${mycmakeargs}) 362 local mycmakeargs_local=(${mycmakeargs})
330 else 363 else
331 local mycmakeargs_local=("${mycmakeargs[@]}") 364 local mycmakeargs_local=("${mycmakeargs[@]}")
332 fi 365 fi
333 366
334 has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=
335
336 # Common configure parameters (overridable) 367 # Common configure parameters (overridable)
337 # NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable 368 # NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable
338 # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect. 369 # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect.
339 local cmakeargs=( 370 local cmakeargs=(
371 --no-warn-unused-cli
340 -C "${common_config}" 372 -C "${common_config}"
341 -DCMAKE_INSTALL_PREFIX="${EPREFIX}${PREFIX:-/usr}" 373 -DCMAKE_INSTALL_PREFIX="${EPREFIX}${PREFIX:-/usr}"
342 "${mycmakeargs_local[@]}" 374 "${mycmakeargs_local[@]}"
343 -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" 375 -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}"
344 -DCMAKE_INSTALL_DO_STRIP=OFF 376 -DCMAKE_INSTALL_DO_STRIP=OFF
345 -DCMAKE_USER_MAKE_RULES_OVERRIDE="${build_rules}" 377 -DCMAKE_USER_MAKE_RULES_OVERRIDE="${build_rules}"
346 "${MYCMAKEARGS}" 378 "${MYCMAKEARGS}"
347 ) 379 )
348 380
349 mkdir -p "${CMAKE_BUILD_DIR}"
350 pushd "${CMAKE_BUILD_DIR}" > /dev/null 381 pushd "${CMAKE_BUILD_DIR}" > /dev/null
351 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is ${mycmakeargs_local[*]}" 382 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is ${mycmakeargs_local[*]}"
352 echo cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" 383 echo "${CMAKE_BINARY}" "${cmakeargs[@]}" "${CMAKE_USE_DIR}"
353 cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" || die "cmake failed" 384 "${CMAKE_BINARY}" "${cmakeargs[@]}" "${CMAKE_USE_DIR}" || die "cmake failed"
354 popd > /dev/null 385 popd > /dev/null
355} 386}
356 387
357enable_cmake-utils_src_compile() { 388enable_cmake-utils_src_compile() {
358 debug-print-function ${FUNCNAME} "$@" 389 debug-print-function ${FUNCNAME} "$@"
383enable_cmake-utils_src_install() { 414enable_cmake-utils_src_install() {
384 debug-print-function ${FUNCNAME} "$@" 415 debug-print-function ${FUNCNAME} "$@"
385 416
386 _check_build_dir 417 _check_build_dir
387 pushd "${CMAKE_BUILD_DIR}" > /dev/null 418 pushd "${CMAKE_BUILD_DIR}" > /dev/null
388 base_src_install 419 base_src_install "$@"
389 popd > /dev/null 420 popd > /dev/null
390 421
391 # Backward compatibility, for non-array variables 422 # Backward compatibility, for non-array variables
392 if [[ -n "${DOCS}" ]] && [[ "$(declare -p DOCS 2>/dev/null 2>&1)" != "declare -a"* ]]; then 423 if [[ -n "${DOCS}" ]] && [[ "$(declare -p DOCS 2>/dev/null 2>&1)" != "declare -a"* ]]; then
393 dodoc ${DOCS} || die "dodoc failed" 424 dodoc ${DOCS} || die "dodoc failed"
397 fi 428 fi
398} 429}
399 430
400enable_cmake-utils_src_test() { 431enable_cmake-utils_src_test() {
401 debug-print-function ${FUNCNAME} "$@" 432 debug-print-function ${FUNCNAME} "$@"
433 local ctestargs
402 434
403 _check_build_dir 435 _check_build_dir
404 pushd "${CMAKE_BUILD_DIR}" > /dev/null 436 pushd "${CMAKE_BUILD_DIR}" > /dev/null
405 local ctestargs 437 [[ -e CTestTestfile.cmake ]] || { echo "No tests found. Skipping."; return 0 ; }
438
406 [[ -n ${TEST_VERBOSE} ]] && ctestargs="--extra-verbose --output-on-failure" 439 [[ -n ${TEST_VERBOSE} ]] && ctestargs="--extra-verbose --output-on-failure"
407 ctest ${ctestargs} || die "Tests failed." 440
441 if ctest ${ctestargs} "$@" ; then
442 einfo "Tests succeeded."
443 else
444 if [[ -n "${CMAKE_YES_I_WANT_TO_SEE_THE_TEST_LOG}" ]] ; then
445 # on request from Diego
446 eerror "Tests failed. Test log ${CMAKE_BUILD_DIR}/Testing/Temporary/LastTest.log follows:"
447 eerror "--START TEST LOG--------------------------------------------------------------"
448 cat "${CMAKE_BUILD_DIR}/Testing/Temporary/LastTest.log"
449 eerror "--END TEST LOG----------------------------------------------------------------"
450 die "Tests failed."
451 else
452 die "Tests failed. When you file a bug, please attach the following file: \n\t${CMAKE_BUILD_DIR}/Testing/Temporary/LastTest.log"
453 fi
454 fi
408 popd > /dev/null 455 popd > /dev/null
409} 456}
410 457
411# @FUNCTION: cmake-utils_src_configure 458# @FUNCTION: cmake-utils_src_configure
412# @DESCRIPTION: 459# @DESCRIPTION:

Legend:
Removed from v.1.56  
changed lines
  Added in v.1.78

  ViewVC Help
Powered by ViewVC 1.1.20