/[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.49 Revision 1.55
1# Copyright 1999-2010 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.49 2010/04/10 02:20:59 reavertm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.55 2010/07/09 16:31:27 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@gmail.com> 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 *)
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
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 104# @ECLASS-VARIABLE: CMAKE_BUILD_DIR
113# @DESCRIPTION: 105# @DESCRIPTION:
114# Set to enable in-source build. 106# Build directory where all cmake processed files should be generated.
115 107# For in-source build it's fixed to ${CMAKE_USE_DIR}.
116# @ECLASS-VARIABLE: CMAKE_VERBOSE 108# For out-of-source build it can be overriden, by default it uses
117# @DESCRIPTION: 109# ${WORKDIR}/${P}_build.
118# Set to enable verbose messages during compilation.
119 110
120# @ECLASS-VARIABLE: CMAKE_BUILD_TYPE 111# @ECLASS-VARIABLE: CMAKE_BUILD_TYPE
121# @DESCRIPTION: 112# @DESCRIPTION:
122# Set to override default CMAKE_BUILD_TYPE. Only useful for packages 113# Set to override default CMAKE_BUILD_TYPE. Only useful for packages
123# known to make use of "if (CMAKE_BUILD_TYPE MATCHES xxx)". 114# 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. 115# 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 116# You usualy do *NOT* want nor need to set it as it pulls CMake default build-type
126# specific compiler flags overriding make.conf. 117# specific compiler flags overriding make.conf.
127: ${CMAKE_BUILD_TYPE:=Gentoo} 118: ${CMAKE_BUILD_TYPE:=Gentoo}
128 119
129# @FUNCTION: _check_build_dir 120# @ECLASS-VARIABLE: CMAKE_IN_SOURCE_BUILD
130# @DESCRIPTION: 121# @DESCRIPTION:
122# Set to enable in-source build.
123
124# @ECLASS-VARIABLE: CMAKE_USE_DIR
125# @DESCRIPTION:
126# Sets the directory where we are working with cmake.
127# For example when application uses autotools and only one
128# plugin needs to be done by cmake.
129# By default it uses ${S}.
130
131# @ECLASS-VARIABLE: CMAKE_VERBOSE
132# @DESCRIPTION:
133# Set to enable verbose messages during compilation.
134
135# @ECLASS-VARIABLE: PREFIX
136# @DESCRIPTION:
137# Eclass respects PREFIX variable, though it's not recommended way to set
138# install/lib/bin prefixes.
139# Use -DCMAKE_INSTALL_PREFIX=... CMake variable instead.
140
131# Determine using IN or OUT source build 141# Determine using IN or OUT source build
132_check_build_dir() { 142_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}} 143 : ${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 144 if [[ -n ${CMAKE_IN_SOURCE_BUILD} ]]; then
148 # we build in source dir 145 # we build in source dir
149 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}" 146 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}"
150 elif [[ ${CMAKE_USE_DIR} = ${WORKDIR} ]]; then 147 elif [[ ${CMAKE_USE_DIR} = ${WORKDIR} ]]; then
151 # out of tree build, but with $S=$WORKDIR, see bug #273949 for reason. 148 # out of tree build, but with $S=$WORKDIR, see bug #273949 for reason.
236 233
237 # Comment out all set (<some_should_be_user_defined_variable> value) 234 # Comment out all set (<some_should_be_user_defined_variable> value)
238 # TODO Add QA checker - inform when variable being checked for below is set in CMakeLists.txt 235 # TODO Add QA checker - inform when variable being checked for below is set in CMakeLists.txt
239 find "${CMAKE_USE_DIR}" -name CMakeLists.txt \ 236 find "${CMAKE_USE_DIR}" -name CMakeLists.txt \
240 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_BUILD_TYPE.*)/{s/^/#IGNORE /g}' {} + \ 237 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_BUILD_TYPE.*)/{s/^/#IGNORE /g}' {} + \
238 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_COLOR_MAKEFILE.*)/{s/^/#IGNORE /g}' {} + \
241 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \ 239 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \
240 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_VERBOSE_MAKEFILE.*)/{s/^/#IGNORE /g}' {} + \
242 || die "${LINENO}: failed to disable hardcoded settings" 241 || die "${LINENO}: failed to disable hardcoded settings"
243 242
244 # NOTE Append some useful summary here 243 # NOTE Append some useful summary here
245 cat >> CMakeLists.txt <<- _EOF_ 244 cat >> CMakeLists.txt <<- _EOF_
246 245
255 Module \${CMAKE_MODULE_LINKER_FLAGS} 254 Module \${CMAKE_MODULE_LINKER_FLAGS}
256 Shared \${CMAKE_SHARED_LINKER_FLAGS}\n") 255 Shared \${CMAKE_SHARED_LINKER_FLAGS}\n")
257 _EOF_ 256 _EOF_
258} 257}
259 258
260# @FUNCTION: enable_cmake-utils_src_configure
261# @DESCRIPTION:
262# General function for configuring with cmake. Default behaviour is to start an
263# out-of-source build.
264enable_cmake-utils_src_configure() { 259enable_cmake-utils_src_configure() {
265 debug-print-function ${FUNCNAME} "$@" 260 debug-print-function ${FUNCNAME} "$@"
266 261
267 _check_build_dir init 262 _check_build_dir init
268 263
314 local libdir=$(get_libdir) 309 local libdir=$(get_libdir)
315 cat > "${common_config}" <<- _EOF_ 310 cat > "${common_config}" <<- _EOF_
316 SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE) 311 SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
317 SET (CMAKE_INSTALL_LIBDIR ${libdir} CACHE PATH "Output directory for libraries") 312 SET (CMAKE_INSTALL_LIBDIR ${libdir} CACHE PATH "Output directory for libraries")
318 _EOF_ 313 _EOF_
319 [[ -n ${NOCOLOR} ]] || echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}" 314 [[ "${NOCOLOR}" = true || "${NOCOLOR}" = yes ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}"
320 315
321 # Convert mycmakeargs to an array, for backwards compatibility 316 # Convert mycmakeargs to an array, for backwards compatibility
322 # Make the array a local variable since <=portage-2.1.6.x does not 317 # Make the array a local variable since <=portage-2.1.6.x does not
323 # support global arrays (see bug #297255). 318 # support global arrays (see bug #297255).
324 if [[ $(declare -p mycmakeargs 2>&-) != "declare -a mycmakeargs="* ]]; then 319 if [[ $(declare -p mycmakeargs 2>&-) != "declare -a mycmakeargs="* ]]; then
345 mkdir -p "${CMAKE_BUILD_DIR}" 340 mkdir -p "${CMAKE_BUILD_DIR}"
346 pushd "${CMAKE_BUILD_DIR}" > /dev/null 341 pushd "${CMAKE_BUILD_DIR}" > /dev/null
347 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is ${mycmakeargs_local[*]}" 342 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is ${mycmakeargs_local[*]}"
348 echo cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" 343 echo cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}"
349 cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" || die "cmake failed" 344 cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" || die "cmake failed"
350
351 popd > /dev/null 345 popd > /dev/null
352} 346}
353 347
354# @FUNCTION: enable_cmake-utils_src_compile
355# @DESCRIPTION:
356# General function for compiling with cmake. Default behaviour is to check for
357# EAPI and respectively to configure as well or just compile.
358enable_cmake-utils_src_compile() { 348enable_cmake-utils_src_compile() {
359 debug-print-function ${FUNCNAME} "$@" 349 debug-print-function ${FUNCNAME} "$@"
360 350
361 has src_configure ${CMAKE_EXPF} || cmake-utils_src_configure 351 has src_configure ${CMAKE_EXPF} || cmake-utils_src_configure
362 cmake-utils_src_make "$@" 352 cmake-utils_src_make "$@"
363} 353}
364 354
365# @FUNCTION: cmake-utils_src_make 355# @FUNCTION: cmake-utils_src_make
366# @DESCRIPTION: 356# @DESCRIPTION:
367# Function for building the package. Automatically detects the build type. 357# Function for building the package. Automatically detects the build type.
368# All arguments are passed to emake 358# All arguments are passed to emake.
369cmake-utils_src_make() { 359cmake-utils_src_make() {
370 debug-print-function ${FUNCNAME} "$@" 360 debug-print-function ${FUNCNAME} "$@"
371 361
372 _check_build_dir 362 _check_build_dir
373 pushd "${CMAKE_BUILD_DIR}" &> /dev/null 363 pushd "${CMAKE_BUILD_DIR}" > /dev/null
374 # first check if Makefile exist otherwise die 364 # first check if Makefile exist otherwise die
375 [[ -e Makefile ]] || die "Makefile not found. Error during configure stage." 365 [[ -e Makefile ]] || die "Makefile not found. Error during configure stage."
376 if [[ -n ${CMAKE_VERBOSE} ]]; then 366 if [[ -n ${CMAKE_VERBOSE} ]]; then
377 emake VERBOSE=1 "$@" || die "Make failed!" 367 emake VERBOSE=1 "$@" || die "Make failed!"
378 else 368 else
379 emake "$@" || die "Make failed!" 369 emake "$@" || die "Make failed!"
380 fi 370 fi
381 popd &> /dev/null 371 popd > /dev/null
382} 372}
383 373
384# @FUNCTION: enable_cmake-utils_src_install
385# @DESCRIPTION:
386# Function for installing the package. Automatically detects the build type.
387enable_cmake-utils_src_install() { 374enable_cmake-utils_src_install() {
388 debug-print-function ${FUNCNAME} "$@" 375 debug-print-function ${FUNCNAME} "$@"
389 376
390 _check_build_dir 377 _check_build_dir
391 pushd "${CMAKE_BUILD_DIR}" &> /dev/null 378 pushd "${CMAKE_BUILD_DIR}" > /dev/null
392 emake install DESTDIR="${D}" || die "Make install failed" 379 base_src_install
393 popd &> /dev/null 380 popd > /dev/null
394 381
395 # Manual document installation 382 # Backward compatibility, for non-array variables
396 [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; } 383 if [[ -n "${DOCS}" ]] && [[ "$(declare -p DOCS 2>/dev/null 2>&1)" != "declare -a"* ]]; then
397 [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; } 384 dodoc ${DOCS} || die "dodoc failed"
385 fi
386 if [[ -n "${HTML_DOCS}" ]] && [[ "$(declare -p HTML_DOCS 2>/dev/null 2>&1)" != "declare -a"* ]]; then
387 dohtml -r ${HTML_DOCS} || die "dohtml failed"
388 fi
398} 389}
399 390
400# @FUNCTION: enable_cmake-utils_src_test
401# @DESCRIPTION:
402# Function for testing the package. Automatically detects the build type.
403enable_cmake-utils_src_test() { 391enable_cmake-utils_src_test() {
404 debug-print-function ${FUNCNAME} "$@" 392 debug-print-function ${FUNCNAME} "$@"
405 393
406 _check_build_dir 394 _check_build_dir
407 pushd "${CMAKE_BUILD_DIR}" &> /dev/null 395 pushd "${CMAKE_BUILD_DIR}" > /dev/null
408 # Standard implementation of src_test 396 local ctestargs
409 if emake -j1 check -n &> /dev/null; then 397 [[ -n ${TEST_VERBOSE} ]] && ctestargs="--extra-verbose --output-on-failure"
410 einfo ">>> Test phase [check]: ${CATEGORY}/${PF}" 398 ctest ${ctestargs} || die "Tests failed."
411 if ! emake -j1 check; then
412 die "Make check failed. See above for details."
413 fi
414 elif emake -j1 test -n &> /dev/null; then
415 einfo ">>> Test phase [test]: ${CATEGORY}/${PF}"
416 if ! emake -j1 test; then
417 die "Make test failed. See above for details."
418 fi
419 else
420 einfo ">>> Test phase [none]: ${CATEGORY}/${PF}"
421 fi
422 popd &> /dev/null 399 popd > /dev/null
423} 400}
424 401
425## Wrappers for calls bellow this line
426# @FUNCTION: cmake-utils_src_configure 402# @FUNCTION: cmake-utils_src_configure
427# @DESCRIPTION: 403# @DESCRIPTION:
428# Wrapper for detection if we want to run enable_ prefixed function with same name 404# General function for configuring with cmake. Default behaviour is to start an
429# unconditionaly or only when some useflag is enabled. 405# out-of-source build.
430cmake-utils_src_configure() { 406cmake-utils_src_configure() {
431 _execute_optionaly "src_configure" "$@" 407 _execute_optionaly "src_configure" "$@"
432} 408}
433 409
434# @FUNCTION: cmake-utils_src_compile 410# @FUNCTION: cmake-utils_src_compile
435# @DESCRIPTION: 411# @DESCRIPTION:
436# Wrapper for detection if we want to run enable_ prefixed function with same name 412# General function for compiling with cmake. Default behaviour is to check for
437# unconditionaly or only when some useflag is enabled. 413# EAPI and respectively to configure as well or just compile.
414# Automatically detects the build type. All arguments are passed to emake.
438cmake-utils_src_compile() { 415cmake-utils_src_compile() {
439 _execute_optionaly "src_compile" "$@" 416 _execute_optionaly "src_compile" "$@"
440} 417}
441 418
442# @FUNCTION: cmake-utils_src_install 419# @FUNCTION: cmake-utils_src_install
443# @DESCRIPTION: 420# @DESCRIPTION:
444# Wrapper for detection if we want to run enable_ prefixed function with same name 421# Function for installing the package. Automatically detects the build type.
445# unconditionaly or only when some useflag is enabled.
446cmake-utils_src_install() { 422cmake-utils_src_install() {
447 _execute_optionaly "src_install" "$@" 423 _execute_optionaly "src_install" "$@"
448} 424}
449 425
450# @FUNCTION: cmake-utils_src_test 426# @FUNCTION: cmake-utils_src_test
451# @DESCRIPTION: 427# @DESCRIPTION:
452# Wrapper for detection if we want to run enable_ prefixed function with same name 428# Function for testing the package. Automatically detects the build type.
453# unconditionaly or only when some useflag is enabled.
454cmake-utils_src_test() { 429cmake-utils_src_test() {
455 _execute_optionaly "src_test" "$@" 430 _execute_optionaly "src_test" "$@"
456} 431}
457 432
458 433# Optionally executes phases based on WANT_CMAKE variable/USE flag.
459_execute_optionaly() { 434_execute_optionaly() {
460 local phase="$1" ; shift 435 local phase="$1" ; shift
461 if [[ ${WANT_CMAKE} = always ]]; then 436 if [[ ${WANT_CMAKE} = always ]]; then
462 enable_cmake-utils_${phase} "$@" 437 enable_cmake-utils_${phase} "$@"
463 else 438 else

Legend:
Removed from v.1.49  
changed lines
  Added in v.1.55

  ViewVC Help
Powered by ViewVC 1.1.20