/[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.27 Revision 1.33
1# Copyright 1999-2009 Gentoo Foundation 1# Copyright 1999-2009 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.27 2009/05/27 14:34:33 scarabeus Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.33 2009/10/27 14:30:35 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#
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# Its main features are support of out-of-source builds as well as in-source
20# builds and an implementation of the well-known use_enable and use_with 20# builds and an implementation of the well-known use_enable and use_with
21# functions for CMake. 21# functions for CMake.
22 22
23# @ECLASS-VARIABLE: WANT_CMAKE
24# @DESCRIPTION:
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.
27# Valid values are: always [default], optional (where the value is the useflag
28# used for optionality)
29WANT_CMAKE="${WANT_CMAKE:-always}"
30CMAKEDEPEND=""
31case ${WANT_CMAKE} in
32 always)
33 ;;
34 *)
35 IUSE+=" ${WANT_CMAKE}"
36 CMAKEDEPEND+="${WANT_CMAKE}? ( "
37 ;;
38esac
23inherit toolchain-funcs multilib flag-o-matic base 39inherit toolchain-funcs multilib flag-o-matic base
24 40
25EXPF="src_compile src_test src_install" 41CMAKE_EXPF="src_compile src_test src_install"
26case ${EAPI:-0} in 42case ${EAPI:-0} in
27 2) EXPF="${EXPF} src_configure" ;; 43 2) CMAKE_EXPF+=" src_configure" ;;
28 1|0) ;; 44 1|0) ;;
29 *) die "Unknown EAPI, Bug eclass maintainers." ;; 45 *) die "Unknown EAPI, Bug eclass maintainers." ;;
30esac 46esac
31EXPORT_FUNCTIONS ${EXPF} 47EXPORT_FUNCTIONS ${CMAKE_EXPF}
32 48
33: ${DESCRIPTION:="Based on the ${ECLASS} eclass"} 49: ${DESCRIPTION:="Based on the ${ECLASS} eclass"}
34 50
35if [[ ${PN} != cmake ]]; then 51if [[ ${PN} != cmake ]]; then
36 CMAKEDEPEND=">=dev-util/cmake-2.6.2-r1" 52 CMAKEDEPEND+=">=dev-util/cmake-2.6.2-r1"
37fi 53fi
38 54
55CMAKEDEPEND+="userland_GNU? ( >=sys-apps/findutils-4.4.0 )"
56
57[[ ${WANT_CMAKE} = always ]] || CMAKEDEPEND+=" )"
58
39DEPEND="${CMAKEDEPEND} 59DEPEND="${CMAKEDEPEND}"
40 userland_GNU? ( >=sys-apps/findutils-4.4.0 ) 60unset CMAKEDEPEND
41"
42 61
43# Internal functions used by cmake-utils_use_* 62# Internal functions used by cmake-utils_use_*
44_use_me_now() { 63_use_me_now() {
45 debug-print-function ${FUNCNAME} "$@" 64 debug-print-function ${FUNCNAME} "$@"
46 65
128 # Specify the build directory where all cmake processed 147 # Specify the build directory where all cmake processed
129 # files should be located. 148 # files should be located.
130 # 149 #
131 # For installing binary doins "${CMAKE_BUILD_DIR}/${PN}" 150 # For installing binary doins "${CMAKE_BUILD_DIR}/${PN}"
132 if [[ -n "${CMAKE_IN_SOURCE_BUILD}" ]]; then 151 if [[ -n "${CMAKE_IN_SOURCE_BUILD}" ]]; then
152 # we build in source dir
133 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}" 153 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}"
134 else 154 elif [[ ${CMAKE_USE_DIR} = ${WORKDIR} ]]; then
155 # out of tree build, but with $S=$WORKDIR, see bug #273949 for reason.
135 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}_build" 156 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}/build"
157 else
158 # regular out of tree build
159 [[ ${1} = init || -d ${CMAKE_USE_DIR}_build ]] && SUF="_build" || SUF=""
160 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}${SUF}"
161
136 fi 162 fi
137 echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\"" 163 echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\""
138} 164}
139# @FUNCTION: cmake-utils_use_with 165# @FUNCTION: cmake-utils_use_with
140# @USAGE: <USE flag> [flag name] 166# @USAGE: <USE flag> [flag name]
196# Based on use_enable. See ebuild(5). 222# Based on use_enable. See ebuild(5).
197# 223#
198# `cmake-utils_use_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled 224# `cmake-utils_use_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled
199# and -DHAVE_FOO=OFF if it is disabled. 225# and -DHAVE_FOO=OFF if it is disabled.
200cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; } 226cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; }
201
202# @FUNCTION: cmake-utils_has
203# @DESCRIPTION:
204# Deprecated, use cmake-utils_use_has, kept now for backcompat.
205cmake-utils_has() { ewarn "QA notice: using deprecated ${FUNCNAME} call, use cmake-utils_use_has instead." ; _use_me_now HAVE_ "$@" ; }
206 227
207# @FUNCTION: cmake-utils_use 228# @FUNCTION: cmake-utils_use
208# @USAGE: <USE flag> [flag name] 229# @USAGE: <USE flag> [flag name]
209# @DESCRIPTION: 230# @DESCRIPTION:
210# Based on use_enable. See ebuild(5). 231# Based on use_enable. See ebuild(5).
230MESSAGE(STATUS "<<< Gentoo configuration >>> 251MESSAGE(STATUS "<<< Gentoo configuration >>>
231Build type: ${CMAKE_BUILD_TYPE} 252Build type: ${CMAKE_BUILD_TYPE}
232Install path: ${CMAKE_INSTALL_PREFIX}\n")' >> CMakeLists.txt 253Install path: ${CMAKE_INSTALL_PREFIX}\n")' >> CMakeLists.txt
233} 254}
234 255
235# @FUNCTION: cmake-utils_src_configure 256# @FUNCTION: enable_cmake-utils_src_configure
236# @DESCRIPTION: 257# @DESCRIPTION:
237# General function for configuring with cmake. Default behaviour is to start an 258# General function for configuring with cmake. Default behaviour is to start an
238# out-of-source build. 259# out-of-source build.
239cmake-utils_src_configure() { 260enable_cmake-utils_src_configure() {
240 debug-print-function ${FUNCNAME} "$@" 261 debug-print-function ${FUNCNAME} "$@"
241 262
242 _check_build_dir 263 _check_build_dir init
243 264
244 # check if CMakeLists.txt exist and if no then die 265 # check if CMakeLists.txt exist and if no then die
245 if [[ ! -e "${CMAKE_USE_DIR}"/CMakeLists.txt ]] ; then 266 if [[ ! -e "${CMAKE_USE_DIR}"/CMakeLists.txt ]] ; then
246 eerror "I was unable to locate CMakeLists.txt under:" 267 eerror "I was unable to locate CMakeLists.txt under:"
247 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\"" 268 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\""
249 die "FATAL: Unable to find CMakeLists.txt" 270 die "FATAL: Unable to find CMakeLists.txt"
250 fi 271 fi
251 272
252 # Remove dangerous things. 273 # Remove dangerous things.
253 _modify-cmakelists 274 _modify-cmakelists
275
276 # Fix xdg collision with sandbox
277 export XDG_CONFIG_HOME="${T}"
254 278
255 # @SEE CMAKE_BUILD_TYPE 279 # @SEE CMAKE_BUILD_TYPE
256 if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then 280 if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then
257 # Handle release builds 281 # Handle release builds
258 if ! has debug ${IUSE//+} || ! use debug; then 282 if ! has debug ${IUSE//+} || ! use debug; then
289 cmakeargs="-C ${common_config} ${cmakeargs}" 313 cmakeargs="-C ${common_config} ${cmakeargs}"
290 314
291 mkdir -p "${CMAKE_BUILD_DIR}" 315 mkdir -p "${CMAKE_BUILD_DIR}"
292 pushd "${CMAKE_BUILD_DIR}" > /dev/null 316 pushd "${CMAKE_BUILD_DIR}" > /dev/null
293 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is $cmakeargs" 317 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is $cmakeargs"
318 echo cmake ${cmakeargs} "${CMAKE_USE_DIR}"
294 cmake ${cmakeargs} "${CMAKE_USE_DIR}" || die "cmake failed" 319 cmake ${cmakeargs} "${CMAKE_USE_DIR}" || die "cmake failed"
295 320
296 popd > /dev/null 321 popd > /dev/null
297} 322}
298 323
299# @FUNCTION: cmake-utils_src_compile 324# @FUNCTION: enable_cmake-utils_src_compile
300# @DESCRIPTION: 325# @DESCRIPTION:
301# General function for compiling with cmake. Default behaviour is to check for 326# General function for compiling with cmake. Default behaviour is to check for
302# EAPI and respectively to configure as well or just compile. 327# EAPI and respectively to configure as well or just compile.
303cmake-utils_src_compile() { 328enable_cmake-utils_src_compile() {
304 debug-print-function ${FUNCNAME} "$@" 329 debug-print-function ${FUNCNAME} "$@"
305 330
306 has src_configure ${EXPF} || cmake-utils_src_configure 331 has src_configure ${CMAKE_EXPF} || cmake-utils_src_configure
307 cmake-utils_src_make "$@" 332 cmake-utils_src_make "$@"
308}
309
310# @FUNCTION: cmake-utils_src_configurein
311# @DESCRIPTION:
312# Deprecated
313cmake-utils_src_configurein() {
314 ewarn "QA notice: using deprecated ${FUNCNAME} call, set CMAKE_IN_SOURCE_BUILD=1 instead."
315 cmake-utils_src_configure
316}
317
318# @FUNCTION: cmake-utils_src_configureout
319# @DESCRIPTION:
320# Deprecated
321cmake-utils_src_configureout() {
322 ewarn "QA notice: using deprecated ${FUNCNAME} call, out of source build is enabled by default."
323 cmake-utils_src_configure
324} 333}
325 334
326# @FUNCTION: cmake-utils_src_make 335# @FUNCTION: cmake-utils_src_make
327# @DESCRIPTION: 336# @DESCRIPTION:
328# Function for building the package. Automatically detects the build type. 337# Function for building the package. Automatically detects the build type.
329# All arguments are passed to emake: 338# All arguments are passed to emake:
330cmake-utils_src_make() { 339cmake-utils_src_make() {
331 debug-print-function ${FUNCNAME} "$@" 340 debug-print-function ${FUNCNAME} "$@"
332 341
333 _check_build_dir 342 _check_build_dir
334 pushd "${CMAKE_BUILD_DIR}" > /dev/null 343 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
335 # first check if Makefile exist otherwise die 344 # first check if Makefile exist otherwise die
336 [[ -e Makefile ]] || die "Makefile not found. Error during configure stage." 345 [[ -e Makefile ]] || die "Makefile not found. Error during configure stage."
337 if [[ -n ${CMAKE_VERBOSE} ]]; then 346 if [[ -n ${CMAKE_VERBOSE} ]]; then
338 emake VERBOSE=1 "$@" || die "Make failed!" 347 emake VERBOSE=1 "$@" || die "Make failed!"
339 else 348 else
340 emake "$@" || die "Make failed!" 349 emake "$@" || die "Make failed!"
341 fi 350 fi
342 popd > /dev/null 351 popd &> /dev/null
343} 352}
344 353
345# @FUNCTION: cmake-utils_src_install 354# @FUNCTION: enable_cmake-utils_src_install
346# @DESCRIPTION: 355# @DESCRIPTION:
347# Function for installing the package. Automatically detects the build type. 356# Function for installing the package. Automatically detects the build type.
348cmake-utils_src_install() { 357enable_cmake-utils_src_install() {
349 debug-print-function ${FUNCNAME} "$@" 358 debug-print-function ${FUNCNAME} "$@"
350 359
351 _check_build_dir 360 _check_build_dir
352 pushd "${CMAKE_BUILD_DIR}" > /dev/null 361 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
353 emake install DESTDIR="${D}" || die "Make install failed" 362 emake install DESTDIR="${D}" || die "Make install failed"
354 popd > /dev/null 363 popd &> /dev/null
355 364
356 # Manual document installation 365 # Manual document installation
357 [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; } 366 [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; }
358 [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; } 367 [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; }
359} 368}
360 369
361# @FUNCTION: cmake-utils_src_test 370# @FUNCTION: enable_cmake-utils_src_test
362# @DESCRIPTION: 371# @DESCRIPTION:
363# Function for testing the package. Automatically detects the build type. 372# Function for testing the package. Automatically detects the build type.
364cmake-utils_src_test() { 373enable_cmake-utils_src_test() {
365 debug-print-function ${FUNCNAME} "$@" 374 debug-print-function ${FUNCNAME} "$@"
366 375
367 _check_build_dir 376 _check_build_dir
368 pushd "${CMAKE_BUILD_DIR}" > /dev/null 377 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
369 # Standard implementation of src_test 378 # Standard implementation of src_test
370 if emake -j1 check -n &> /dev/null; then 379 if emake -j1 check -n &> /dev/null; then
371 einfo ">>> Test phase [check]: ${CATEGORY}/${PF}" 380 einfo ">>> Test phase [check]: ${CATEGORY}/${PF}"
372 if ! emake -j1 check; then 381 if ! emake -j1 check; then
373 die "Make check failed. See above for details." 382 die "Make check failed. See above for details."
378 die "Make test failed. See above for details." 387 die "Make test failed. See above for details."
379 fi 388 fi
380 else 389 else
381 einfo ">>> Test phase [none]: ${CATEGORY}/${PF}" 390 einfo ">>> Test phase [none]: ${CATEGORY}/${PF}"
382 fi 391 fi
383 popd > /dev/null 392 popd &> /dev/null
384} 393}
394
395## Wrappers for calls bellow this line
396# @FUNCTION: cmake-utils_src_configure
397# @DESCRIPTION:
398# Wrapper for detection if we want to run enable_ prefixed function with same name
399# unconditionaly or only when some useflag is enabled.
400cmake-utils_src_configure() {
401 _execute_optionaly "src_configure"
402}
403
404# @FUNCTION: cmake-utils_src_compile
405# @DESCRIPTION:
406# Wrapper for detection if we want to run enable_ prefixed function with same name
407# unconditionaly or only when some useflag is enabled.
408cmake-utils_src_compile() {
409 _execute_optionaly "src_compile"
410}
411
412# @FUNCTION: cmake-utils_src_install
413# @DESCRIPTION:
414# Wrapper for detection if we want to run enable_ prefixed function with same name
415# unconditionaly or only when some useflag is enabled.
416cmake-utils_src_install() {
417 _execute_optionaly "src_install"
418}
419
420# @FUNCTION: cmake-utils_src_test
421# @DESCRIPTION:
422# Wrapper for detection if we want to run enable_ prefixed function with same name
423# unconditionaly or only when some useflag is enabled.
424cmake-utils_src_test() {
425 _execute_optionaly "src_test"
426}
427
428
429_execute_optionaly() {
430 local phase="$1"
431 if [[ ${WANT_CMAKE} = always ]]; then
432 enable_cmake-utils_${phase}
433 else
434 use ${WANT_CMAKE} && enable_cmake-utils_${phase}
435 fi
436}

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

  ViewVC Help
Powered by ViewVC 1.1.20