/[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.51 Revision 1.57
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.51 2010/04/30 23:58:47 abcd Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.57 2010/08/12 19:27:42 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.
28# used for optionality) 28# used for optionality)
29WANT_CMAKE="${WANT_CMAKE:-always}" 29WANT_CMAKE="${WANT_CMAKE:-always}"
30 30
31# @ECLASS-VARIABLE: CMAKE_MIN_VERSION 31# @ECLASS-VARIABLE: CMAKE_MIN_VERSION
32# @DESCRIPTION: 32# @DESCRIPTION:
33# Specify the minimum allowable version of cmake. Defaults to 2.6.2-r1 33# Specify the minimum required CMake version. Default is 2.6.2-r1
34CMAKE_MIN_VERSION="${CMAKE_MIN_VERSION:-2.6.2-r1}" 34CMAKE_MIN_VERSION="${CMAKE_MIN_VERSION:-2.6.2-r1}"
35 35
36CMAKEDEPEND="" 36CMAKEDEPEND=""
37case ${WANT_CMAKE} in 37case ${WANT_CMAKE} in
38 always) 38 always)
99 echo "-D$1$x=$(use $2 && echo OFF || echo ON) " 99 echo "-D$1$x=$(use $2 && echo OFF || echo ON) "
100 done 100 done
101 fi 101 fi
102} 102}
103 103
104# @ECLASS-VARIABLE: DOCS
105# @DESCRIPTION:
106# Documents passed to dodoc command.
107
108# @ECLASS-VARIABLE: HTML_DOCS
109# @DESCRIPTION:
110# Documents passed to dohtml command.
111
112# @ECLASS-VARIABLE: PREFIX
113# @DESCRIPTION:
114# 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 104# @ECLASS-VARIABLE: CMAKE_BUILD_DIR
119# @DESCRIPTION: 105# @DESCRIPTION:
120# Set to enable in-source build. 106# Build directory where all cmake processed files should be generated.
121 107# For in-source build it's fixed to ${CMAKE_USE_DIR}.
122# @ECLASS-VARIABLE: CMAKE_VERBOSE 108# For out-of-source build it can be overriden, by default it uses
123# @DESCRIPTION: 109# ${WORKDIR}/${P}_build.
124# Set to enable verbose messages during compilation.
125 110
126# @ECLASS-VARIABLE: CMAKE_BUILD_TYPE 111# @ECLASS-VARIABLE: CMAKE_BUILD_TYPE
127# @DESCRIPTION: 112# @DESCRIPTION:
128# Set to override default CMAKE_BUILD_TYPE. Only useful for packages 113# Set to override default CMAKE_BUILD_TYPE. Only useful for packages
129# known to make use of "if (CMAKE_BUILD_TYPE MATCHES xxx)". 114# 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. 115# 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 116# You usualy do *NOT* want nor need to set it as it pulls CMake default build-type
132# specific compiler flags overriding make.conf. 117# specific compiler flags overriding make.conf.
133: ${CMAKE_BUILD_TYPE:=Gentoo} 118: ${CMAKE_BUILD_TYPE:=Gentoo}
134 119
135# @FUNCTION: _check_build_dir 120# @ECLASS-VARIABLE: CMAKE_IN_SOURCE_BUILD
136# @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
137# Determine using IN or OUT source build 141# Determine using IN or OUT source build
138_check_build_dir() { 142_check_build_dir() {
139 # @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}} 143 : ${CMAKE_USE_DIR:=${S}}
146
147 # @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 if [[ -n ${CMAKE_IN_SOURCE_BUILD} ]]; then 144 if [[ -n ${CMAKE_IN_SOURCE_BUILD} ]]; then
154 # we build in source dir 145 # we build in source dir
155 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}" 146 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}"
156 elif [[ ${CMAKE_USE_DIR} = ${WORKDIR} ]]; then 147 elif [[ ${CMAKE_USE_DIR} = ${WORKDIR} ]]; then
157 # 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.
224# 215#
225# `cmake-utils_use_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled 216# `cmake-utils_use_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled
226# and -DHAVE_FOO=OFF if it is disabled. 217# and -DHAVE_FOO=OFF if it is disabled.
227cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; } 218cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; }
228 219
220# @FUNCTION: cmake-utils_use_use
221# @USAGE: <USE flag> [flag name]
222# @DESCRIPTION:
223# Based on use_enable. See ebuild(5).
224#
225# `cmake-utils_use_use foo FOO` echoes -DUSE_FOO=ON if foo is enabled
226# and -DUSE_FOO=OFF if it is disabled.
227cmake-utils_use_use() { _use_me_now USE_ "$@" ; }
228
229# @FUNCTION: cmake-utils_use 229# @FUNCTION: cmake-utils_use
230# @USAGE: <USE flag> [flag name] 230# @USAGE: <USE flag> [flag name]
231# @DESCRIPTION: 231# @DESCRIPTION:
232# Based on use_enable. See ebuild(5). 232# Based on use_enable. See ebuild(5).
233# 233#
242 242
243 # Comment out all set (<some_should_be_user_defined_variable> value) 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 244 # TODO Add QA checker - inform when variable being checked for below is set in CMakeLists.txt
245 find "${CMAKE_USE_DIR}" -name CMakeLists.txt \ 245 find "${CMAKE_USE_DIR}" -name CMakeLists.txt \
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_BUILD_TYPE.*)/{s/^/#IGNORE /g}' {} + \
247 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_COLOR_MAKEFILE.*)/{s/^/#IGNORE /g}' {} + \
247 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \ 248 -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}' {} + \
248 || die "${LINENO}: failed to disable hardcoded settings" 250 || die "${LINENO}: failed to disable hardcoded settings"
249 251
250 # NOTE Append some useful summary here 252 # NOTE Append some useful summary here
251 cat >> CMakeLists.txt <<- _EOF_ 253 cat >> CMakeLists.txt <<- _EOF_
252 254
261 Module \${CMAKE_MODULE_LINKER_FLAGS} 263 Module \${CMAKE_MODULE_LINKER_FLAGS}
262 Shared \${CMAKE_SHARED_LINKER_FLAGS}\n") 264 Shared \${CMAKE_SHARED_LINKER_FLAGS}\n")
263 _EOF_ 265 _EOF_
264} 266}
265 267
266# @FUNCTION: enable_cmake-utils_src_configure
267# @DESCRIPTION:
268# General function for configuring with cmake. Default behaviour is to start an
269# out-of-source build.
270enable_cmake-utils_src_configure() { 268enable_cmake-utils_src_configure() {
271 debug-print-function ${FUNCNAME} "$@" 269 debug-print-function ${FUNCNAME} "$@"
272 270
273 _check_build_dir init 271 _check_build_dir init
274 272
286 # Fix xdg collision with sandbox 284 # Fix xdg collision with sandbox
287 export XDG_CONFIG_HOME="${T}" 285 export XDG_CONFIG_HOME="${T}"
288 286
289 # @SEE CMAKE_BUILD_TYPE 287 # @SEE CMAKE_BUILD_TYPE
290 if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then 288 if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then
291 # Handle release builds 289 # Handle debug and release codepaths
292 if ! has debug ${IUSE//+} || ! use debug; then 290 if has debug ${IUSE//+} && use debug; then
293 append-cppflags -DNDEBUG 291 append-cppflags -DDEBUG
292 else
293 append-cppflags -DNDEBUG -DQT_NO_DEBUG -DQT_NO_DEBUG_STREAM
294 fi 294 fi
295 fi 295 fi
296 296
297 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS) 297 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
298 local build_rules=${T}/gentoo_rules.cmake 298 local build_rules=${T}/gentoo_rules.cmake
320 local libdir=$(get_libdir) 320 local libdir=$(get_libdir)
321 cat > "${common_config}" <<- _EOF_ 321 cat > "${common_config}" <<- _EOF_
322 SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE) 322 SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
323 SET (CMAKE_INSTALL_LIBDIR ${libdir} CACHE PATH "Output directory for libraries") 323 SET (CMAKE_INSTALL_LIBDIR ${libdir} CACHE PATH "Output directory for libraries")
324 _EOF_ 324 _EOF_
325 [[ -n ${NOCOLOR} ]] || echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}" 325 [[ "${NOCOLOR}" = true || "${NOCOLOR}" = yes ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}"
326 326
327 # Convert mycmakeargs to an array, for backwards compatibility 327 # Convert mycmakeargs to an array, for backwards compatibility
328 # Make the array a local variable since <=portage-2.1.6.x does not 328 # Make the array a local variable since <=portage-2.1.6.x does not
329 # support global arrays (see bug #297255). 329 # support global arrays (see bug #297255).
330 if [[ $(declare -p mycmakeargs 2>&-) != "declare -a mycmakeargs="* ]]; then 330 if [[ $(declare -p mycmakeargs 2>&-) != "declare -a mycmakeargs="* ]]; then
351 mkdir -p "${CMAKE_BUILD_DIR}" 351 mkdir -p "${CMAKE_BUILD_DIR}"
352 pushd "${CMAKE_BUILD_DIR}" > /dev/null 352 pushd "${CMAKE_BUILD_DIR}" > /dev/null
353 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is ${mycmakeargs_local[*]}" 353 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is ${mycmakeargs_local[*]}"
354 echo cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" 354 echo cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}"
355 cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" || die "cmake failed" 355 cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" || die "cmake failed"
356
357 popd > /dev/null 356 popd > /dev/null
358} 357}
359 358
360# @FUNCTION: enable_cmake-utils_src_compile
361# @DESCRIPTION:
362# General function for compiling with cmake. Default behaviour is to check for
363# EAPI and respectively to configure as well or just compile.
364enable_cmake-utils_src_compile() { 359enable_cmake-utils_src_compile() {
365 debug-print-function ${FUNCNAME} "$@" 360 debug-print-function ${FUNCNAME} "$@"
366 361
367 has src_configure ${CMAKE_EXPF} || cmake-utils_src_configure 362 has src_configure ${CMAKE_EXPF} || cmake-utils_src_configure
368 cmake-utils_src_make "$@" 363 cmake-utils_src_make "$@"
369} 364}
370 365
371# @FUNCTION: cmake-utils_src_make 366# @FUNCTION: cmake-utils_src_make
372# @DESCRIPTION: 367# @DESCRIPTION:
373# Function for building the package. Automatically detects the build type. 368# Function for building the package. Automatically detects the build type.
374# All arguments are passed to emake 369# All arguments are passed to emake.
375cmake-utils_src_make() { 370cmake-utils_src_make() {
376 debug-print-function ${FUNCNAME} "$@" 371 debug-print-function ${FUNCNAME} "$@"
377 372
378 _check_build_dir 373 _check_build_dir
379 pushd "${CMAKE_BUILD_DIR}" &> /dev/null 374 pushd "${CMAKE_BUILD_DIR}" > /dev/null
380 # first check if Makefile exist otherwise die 375 # first check if Makefile exist otherwise die
381 [[ -e Makefile ]] || die "Makefile not found. Error during configure stage." 376 [[ -e Makefile ]] || die "Makefile not found. Error during configure stage."
382 if [[ -n ${CMAKE_VERBOSE} ]]; then 377 if [[ -n ${CMAKE_VERBOSE} ]]; then
383 emake VERBOSE=1 "$@" || die "Make failed!" 378 emake VERBOSE=1 "$@" || die "Make failed!"
384 else 379 else
385 emake "$@" || die "Make failed!" 380 emake "$@" || die "Make failed!"
386 fi 381 fi
387 popd &> /dev/null 382 popd > /dev/null
388} 383}
389 384
390# @FUNCTION: enable_cmake-utils_src_install
391# @DESCRIPTION:
392# Function for installing the package. Automatically detects the build type.
393enable_cmake-utils_src_install() { 385enable_cmake-utils_src_install() {
394 debug-print-function ${FUNCNAME} "$@" 386 debug-print-function ${FUNCNAME} "$@"
395 387
396 _check_build_dir 388 _check_build_dir
397 pushd "${CMAKE_BUILD_DIR}" &> /dev/null 389 pushd "${CMAKE_BUILD_DIR}" > /dev/null
398 emake install DESTDIR="${D}" || die "Make install failed" 390 base_src_install
399 popd &> /dev/null 391 popd > /dev/null
400 392
401 # Manual document installation 393 # Backward compatibility, for non-array variables
402 [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; } 394 if [[ -n "${DOCS}" ]] && [[ "$(declare -p DOCS 2>/dev/null 2>&1)" != "declare -a"* ]]; then
403 [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; } 395 dodoc ${DOCS} || die "dodoc failed"
396 fi
397 if [[ -n "${HTML_DOCS}" ]] && [[ "$(declare -p HTML_DOCS 2>/dev/null 2>&1)" != "declare -a"* ]]; then
398 dohtml -r ${HTML_DOCS} || die "dohtml failed"
399 fi
404} 400}
405 401
406# @FUNCTION: enable_cmake-utils_src_test
407# @DESCRIPTION:
408# Function for testing the package. Automatically detects the build type.
409enable_cmake-utils_src_test() { 402enable_cmake-utils_src_test() {
410 debug-print-function ${FUNCNAME} "$@" 403 debug-print-function ${FUNCNAME} "$@"
411 404
412 _check_build_dir 405 _check_build_dir
413 pushd "${CMAKE_BUILD_DIR}" &> /dev/null 406 pushd "${CMAKE_BUILD_DIR}" > /dev/null
414 # Standard implementation of src_test 407 local ctestargs
415 if emake -j1 check -n &> /dev/null; then 408 [[ -n ${TEST_VERBOSE} ]] && ctestargs="--extra-verbose --output-on-failure"
416 einfo ">>> Test phase [check]: ${CATEGORY}/${PF}" 409 ctest ${ctestargs} || die "Tests failed."
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 popd &> /dev/null 410 popd > /dev/null
429} 411}
430 412
431## Wrappers for calls bellow this line
432# @FUNCTION: cmake-utils_src_configure 413# @FUNCTION: cmake-utils_src_configure
433# @DESCRIPTION: 414# @DESCRIPTION:
434# Wrapper for detection if we want to run enable_ prefixed function with same name 415# General function for configuring with cmake. Default behaviour is to start an
435# unconditionaly or only when some useflag is enabled. 416# out-of-source build.
436cmake-utils_src_configure() { 417cmake-utils_src_configure() {
437 _execute_optionaly "src_configure" "$@" 418 _execute_optionaly "src_configure" "$@"
438} 419}
439 420
440# @FUNCTION: cmake-utils_src_compile 421# @FUNCTION: cmake-utils_src_compile
441# @DESCRIPTION: 422# @DESCRIPTION:
442# Wrapper for detection if we want to run enable_ prefixed function with same name 423# General function for compiling with cmake. Default behaviour is to check for
443# unconditionaly or only when some useflag is enabled. 424# EAPI and respectively to configure as well or just compile.
425# Automatically detects the build type. All arguments are passed to emake.
444cmake-utils_src_compile() { 426cmake-utils_src_compile() {
445 _execute_optionaly "src_compile" "$@" 427 _execute_optionaly "src_compile" "$@"
446} 428}
447 429
448# @FUNCTION: cmake-utils_src_install 430# @FUNCTION: cmake-utils_src_install
449# @DESCRIPTION: 431# @DESCRIPTION:
450# Wrapper for detection if we want to run enable_ prefixed function with same name 432# Function for installing the package. Automatically detects the build type.
451# unconditionaly or only when some useflag is enabled.
452cmake-utils_src_install() { 433cmake-utils_src_install() {
453 _execute_optionaly "src_install" "$@" 434 _execute_optionaly "src_install" "$@"
454} 435}
455 436
456# @FUNCTION: cmake-utils_src_test 437# @FUNCTION: cmake-utils_src_test
457# @DESCRIPTION: 438# @DESCRIPTION:
458# Wrapper for detection if we want to run enable_ prefixed function with same name 439# Function for testing the package. Automatically detects the build type.
459# unconditionaly or only when some useflag is enabled.
460cmake-utils_src_test() { 440cmake-utils_src_test() {
461 _execute_optionaly "src_test" "$@" 441 _execute_optionaly "src_test" "$@"
462} 442}
463 443
464 444# Optionally executes phases based on WANT_CMAKE variable/USE flag.
465_execute_optionaly() { 445_execute_optionaly() {
466 local phase="$1" ; shift 446 local phase="$1" ; shift
467 if [[ ${WANT_CMAKE} = always ]]; then 447 if [[ ${WANT_CMAKE} = always ]]; then
468 enable_cmake-utils_${phase} "$@" 448 enable_cmake-utils_${phase} "$@"
469 else 449 else

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

  ViewVC Help
Powered by ViewVC 1.1.20