/[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.39 Revision 1.54
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.39 2009/12/22 22:52:52 scarabeus Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.54 2010/06/26 17:55:59 reavertm 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@gentoo.org>
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:
17# The cmake-utils eclass contains functions that make creating ebuilds for 17# The cmake-utils eclass is base.eclass(5) wrapper that makes creating ebuilds for
18# cmake-based packages much easier. 18# cmake-based packages much easier.
19# Its main features are support of out-of-source builds as well as in-source 19# It provides all inherited features (DOCS, HTML_DOCS, PATCHES) along with out-of-source
20# builds and an implementation of the well-known use_enable and use_with 20# builds (default), in-source builds and an implementation of the well-known use_enable
21# functions for CMake. 21# and use_with functions for CMake.
22 22
23# @ECLASS-VARIABLE: WANT_CMAKE 23# @ECLASS-VARIABLE: WANT_CMAKE
24# @DESCRIPTION: 24# @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
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+=" )"
93 echo "-D$1$x=$(use $2 && echo OFF || echo ON) " 99 echo "-D$1$x=$(use $2 && echo OFF || echo ON) "
94 done 100 done
95 fi 101 fi
96} 102}
97 103
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 104# @ECLASS-VARIABLE: PREFIX
107# @DESCRIPTION: 105# @DESCRIPTION:
108# Eclass respects PREFIX variable, though it's not recommended way to set 106# Eclass respects PREFIX variable, though it's not recommended way to set
109# install/lib/bin prefixes. 107# install/lib/bin prefixes.
110# Use -DCMAKE_INSTALL_PREFIX=... CMake variable instead. 108# Use -DCMAKE_INSTALL_PREFIX=... CMake variable instead.
124# If about to be set - needs to be set before invoking cmake-utils_src_configure. 122# 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 123# You usualy do *NOT* want nor need to set it as it pulls CMake default build-type
126# specific compiler flags overriding make.conf. 124# specific compiler flags overriding make.conf.
127: ${CMAKE_BUILD_TYPE:=Gentoo} 125: ${CMAKE_BUILD_TYPE:=Gentoo}
128 126
129# @FUNCTION: _check_build_dir
130# @DESCRIPTION:
131# Determine using IN or OUT source build 127# Determine using IN or OUT source build
132_check_build_dir() { 128_check_build_dir() {
133 # @ECLASS-VARIABLE: CMAKE_USE_DIR 129 # @ECLASS-VARIABLE: CMAKE_USE_DIR
134 # @DESCRIPTION: 130 # @DESCRIPTION:
135 # Sets the directory where we are working with cmake. 131 # Sets the directory where we are working with cmake.
152 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}/build" 148 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}/build"
153 else 149 else
154 # regular out of tree build 150 # regular out of tree build
155 [[ ${1} = init || -d ${CMAKE_USE_DIR}_build ]] && SUF="_build" || SUF="" 151 [[ ${1} = init || -d ${CMAKE_USE_DIR}_build ]] && SUF="_build" || SUF=""
156 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}${SUF}" 152 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}${SUF}"
157
158 fi 153 fi
159 echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\"" 154 echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\""
160} 155}
161# @FUNCTION: cmake-utils_use_with 156# @FUNCTION: cmake-utils_use_with
162# @USAGE: <USE flag> [flag name] 157# @USAGE: <USE flag> [flag name]
229# `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled 224# `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled
230# and -DFOO=OFF if it is disabled. 225# and -DFOO=OFF if it is disabled.
231cmake-utils_use() { _use_me_now "" "$@" ; } 226cmake-utils_use() { _use_me_now "" "$@" ; }
232 227
233# Internal function for modifying hardcoded definitions. 228# Internal function for modifying hardcoded definitions.
234# Removes dangerous definitionts that override Gentoo settings. 229# Removes dangerous definitions that override Gentoo settings.
235_modify-cmakelists() { 230_modify-cmakelists() {
236 debug-print-function ${FUNCNAME} "$@" 231 debug-print-function ${FUNCNAME} "$@"
237 232
238 # Comment out all set (<some_should_be_user_defined_variable> value) 233 # 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 234 # TODO Add QA checker - inform when variable being checked for below is set in CMakeLists.txt
244 239
245 # NOTE Append some useful summary here 240 # NOTE Append some useful summary here
246 cat >> CMakeLists.txt <<- _EOF_ 241 cat >> CMakeLists.txt <<- _EOF_
247 242
248 MESSAGE(STATUS "<<< Gentoo configuration >>> 243 MESSAGE(STATUS "<<< Gentoo configuration >>>
249 Build type: ${CMAKE_BUILD_TYPE} 244 Build type \${CMAKE_BUILD_TYPE}
250 Install path: ${CMAKE_INSTALL_PREFIX}\n") 245 Install path \${CMAKE_INSTALL_PREFIX}
246 Compiler flags:
247 C \${CMAKE_C_FLAGS}
248 C++ \${CMAKE_CXX_FLAGS}
249 Linker flags:
250 Executable \${CMAKE_EXE_LINKER_FLAGS}
251 Module \${CMAKE_MODULE_LINKER_FLAGS}
252 Shared \${CMAKE_SHARED_LINKER_FLAGS}\n")
251 _EOF_ 253 _EOF_
252} 254}
253 255
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.
258enable_cmake-utils_src_configure() { 256enable_cmake-utils_src_configure() {
259 debug-print-function ${FUNCNAME} "$@" 257 debug-print-function ${FUNCNAME} "$@"
260 258
261 _check_build_dir init 259 _check_build_dir init
262 260
263 # check if CMakeLists.txt exist and if no then die 261 # check if CMakeLists.txt exist and if no then die
264 if [[ ! -e ${CMAKE_USE_DIR}/CMakeLists.txt ]] ; then 262 if [[ ! -e ${CMAKE_USE_DIR}/CMakeLists.txt ]] ; then
265 eerror "I was unable to locate CMakeLists.txt under:" 263 eerror "Unable to locate CMakeLists.txt under:"
266 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\"" 264 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\""
267 eerror "You should consider not inheriting the cmake eclass." 265 eerror "Consider not inheriting the cmake eclass."
268 die "FATAL: Unable to find CMakeLists.txt" 266 die "FATAL: Unable to find CMakeLists.txt"
269 fi 267 fi
270 268
271 # Remove dangerous things. 269 # Remove dangerous things.
272 _modify-cmakelists 270 _modify-cmakelists
297 # right ... except for Darwin hosts 295 # right ... except for Darwin hosts
298 IF (NOT APPLE) 296 IF (NOT APPLE)
299 SET (CMAKE_SKIP_RPATH OFF CACHE BOOL "" FORCE) 297 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)" 298 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) 299 CACHE STRING "" FORCE)
302 SET (CMAKE_BUILD_WITH_INSTALL_RPATH ON CACHE BOOL "" FORCE)
303 ENDIF (NOT APPLE) 300 ENDIF (NOT APPLE)
304 _EOF_ 301 _EOF_
305 fi 302 fi
306 303
307 # Common configure parameters (invariants) 304 # Common configure parameters (invariants)
308 local common_config=${T}/gentoo_common_config.cmake 305 local common_config=${T}/gentoo_common_config.cmake
309 local libdir=$(get_libdir) 306 local libdir=$(get_libdir)
310 cat > "${common_config}" <<- _EOF_ 307 cat > "${common_config}" <<- _EOF_
311 SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE) 308 SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
309 SET (CMAKE_INSTALL_LIBDIR ${libdir} CACHE PATH "Output directory for libraries")
312 _EOF_ 310 _EOF_
313 [[ -n ${NOCOLOR} ]] || echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}" 311 [[ "${NOCOLOR}" = true || "${NOCOLOR}" = yes ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}"
314 312
315 # Convert mycmakeargs to an array, for backwards compatibility 313 # Convert mycmakeargs to an array, for backwards compatibility
316 # Make the array a local variable since <=portage-2.1.6.x does not 314 # Make the array a local variable since <=portage-2.1.6.x does not
317 # support global arrays (see bug #297255). 315 # support global arrays (see bug #297255).
318 if [[ $(declare -p mycmakeargs 2>&-) != "declare -a mycmakeargs="* ]]; then 316 if [[ $(declare -p mycmakeargs 2>&-) != "declare -a mycmakeargs="* ]]; then
331 -DCMAKE_INSTALL_PREFIX="${EPREFIX}${PREFIX:-/usr}" 329 -DCMAKE_INSTALL_PREFIX="${EPREFIX}${PREFIX:-/usr}"
332 "${mycmakeargs_local[@]}" 330 "${mycmakeargs_local[@]}"
333 -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" 331 -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}"
334 -DCMAKE_INSTALL_DO_STRIP=OFF 332 -DCMAKE_INSTALL_DO_STRIP=OFF
335 -DCMAKE_USER_MAKE_RULES_OVERRIDE="${build_rules}" 333 -DCMAKE_USER_MAKE_RULES_OVERRIDE="${build_rules}"
334 "${MYCMAKEARGS}"
336 ) 335 )
337 336
338 mkdir -p "${CMAKE_BUILD_DIR}" 337 mkdir -p "${CMAKE_BUILD_DIR}"
339 pushd "${CMAKE_BUILD_DIR}" > /dev/null 338 pushd "${CMAKE_BUILD_DIR}" > /dev/null
340 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is ${mycmakeargs_local[*]}" 339 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is ${mycmakeargs_local[*]}"
342 cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" || die "cmake failed" 341 cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" || die "cmake failed"
343 342
344 popd > /dev/null 343 popd > /dev/null
345} 344}
346 345
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.
351enable_cmake-utils_src_compile() { 346enable_cmake-utils_src_compile() {
352 debug-print-function ${FUNCNAME} "$@" 347 debug-print-function ${FUNCNAME} "$@"
353 348
354 has src_configure ${CMAKE_EXPF} || cmake-utils_src_configure 349 has src_configure ${CMAKE_EXPF} || cmake-utils_src_configure
355 cmake-utils_src_make "$@" 350 cmake-utils_src_make "$@"
372 emake "$@" || die "Make failed!" 367 emake "$@" || die "Make failed!"
373 fi 368 fi
374 popd &> /dev/null 369 popd &> /dev/null
375} 370}
376 371
377# @FUNCTION: enable_cmake-utils_src_install
378# @DESCRIPTION:
379# Function for installing the package. Automatically detects the build type.
380enable_cmake-utils_src_install() { 372enable_cmake-utils_src_install() {
381 debug-print-function ${FUNCNAME} "$@" 373 debug-print-function ${FUNCNAME} "$@"
382 374
383 _check_build_dir 375 _check_build_dir
384 pushd "${CMAKE_BUILD_DIR}" &> /dev/null 376 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
385 emake install DESTDIR="${D}" || die "Make install failed" 377 base_src_install
386 popd &> /dev/null 378 popd &> /dev/null
387 379
388 # Manual document installation 380 # Backward compatibility, for non-array variables
389 [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; } 381 if [[ -n "${DOCS}" ]] && [[ "$(declare -p DOCS 2>/dev/null 2>&1)" != "declare -a"* ]]; then
390 [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; } 382 dodoc ${DOCS} || die "dodoc failed"
383 fi
384 if [[ -n "${HTML_DOCS}" ]] && [[ "$(declare -p HTML_DOCS 2>/dev/null 2>&1)" != "declare -a"* ]]; then
385 dohtml -r ${HTML_DOCS} || die "dohtml failed"
386 fi
391} 387}
392 388
393# @FUNCTION: enable_cmake-utils_src_test
394# @DESCRIPTION:
395# Function for testing the package. Automatically detects the build type.
396enable_cmake-utils_src_test() { 389enable_cmake-utils_src_test() {
397 debug-print-function ${FUNCNAME} "$@" 390 debug-print-function ${FUNCNAME} "$@"
398 391
399 _check_build_dir 392 _check_build_dir
400 pushd "${CMAKE_BUILD_DIR}" &> /dev/null 393 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
413 einfo ">>> Test phase [none]: ${CATEGORY}/${PF}" 406 einfo ">>> Test phase [none]: ${CATEGORY}/${PF}"
414 fi 407 fi
415 popd &> /dev/null 408 popd &> /dev/null
416} 409}
417 410
418## Wrappers for calls bellow this line
419# @FUNCTION: cmake-utils_src_configure 411# @FUNCTION: cmake-utils_src_configure
420# @DESCRIPTION: 412# @DESCRIPTION:
421# Wrapper for detection if we want to run enable_ prefixed function with same name 413# General function for configuring with cmake. Default behaviour is to start an
422# unconditionaly or only when some useflag is enabled. 414# out-of-source build.
423cmake-utils_src_configure() { 415cmake-utils_src_configure() {
424 _execute_optionaly "src_configure" 416 _execute_optionaly "src_configure" "$@"
425} 417}
426 418
427# @FUNCTION: cmake-utils_src_compile 419# @FUNCTION: cmake-utils_src_compile
428# @DESCRIPTION: 420# @DESCRIPTION:
429# Wrapper for detection if we want to run enable_ prefixed function with same name 421# General function for compiling with cmake. Default behaviour is to check for
430# unconditionaly or only when some useflag is enabled. 422# EAPI and respectively to configure as well or just compile.
423# Automatically detects the build type. All arguments are passed to emake.
431cmake-utils_src_compile() { 424cmake-utils_src_compile() {
432 _execute_optionaly "src_compile" 425 _execute_optionaly "src_compile" "$@"
433} 426}
434 427
435# @FUNCTION: cmake-utils_src_install 428# @FUNCTION: cmake-utils_src_install
436# @DESCRIPTION: 429# @DESCRIPTION:
437# Wrapper for detection if we want to run enable_ prefixed function with same name 430# Function for installing the package. Automatically detects the build type.
438# unconditionaly or only when some useflag is enabled.
439cmake-utils_src_install() { 431cmake-utils_src_install() {
440 _execute_optionaly "src_install" 432 _execute_optionaly "src_install" "$@"
441} 433}
442 434
443# @FUNCTION: cmake-utils_src_test 435# @FUNCTION: cmake-utils_src_test
444# @DESCRIPTION: 436# @DESCRIPTION:
445# Wrapper for detection if we want to run enable_ prefixed function with same name 437# Function for testing the package. Automatically detects the build type.
446# unconditionaly or only when some useflag is enabled.
447cmake-utils_src_test() { 438cmake-utils_src_test() {
448 _execute_optionaly "src_test" 439 _execute_optionaly "src_test" "$@"
449} 440}
450 441
451 442# Optionally executes phases based on WANT_CMAKE variable/USE flag.
452_execute_optionaly() { 443_execute_optionaly() {
453 local phase="$1" 444 local phase="$1" ; shift
454 if [[ ${WANT_CMAKE} = always ]]; then 445 if [[ ${WANT_CMAKE} = always ]]; then
455 enable_cmake-utils_${phase} 446 enable_cmake-utils_${phase} "$@"
456 else 447 else
457 use ${WANT_CMAKE} && enable_cmake-utils_${phase} 448 use ${WANT_CMAKE} && enable_cmake-utils_${phase} "$@"
458 fi 449 fi
459} 450}

Legend:
Removed from v.1.39  
changed lines
  Added in v.1.54

  ViewVC Help
Powered by ViewVC 1.1.20