/[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.28 Revision 1.36
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.28 2009/05/29 08:06:46 scarabeus Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.36 2009/12/10 19:58:42 abcd 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 3|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
127 # @DESCRIPTION: 146 # @DESCRIPTION:
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}"
154 elif [[ ${CMAKE_USE_DIR} = ${WORKDIR} ]]; then
155 # out of tree build, but with $S=$WORKDIR, see bug #273949 for reason.
156 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}/build"
134 else 157 else
158 # regular out of tree build
135 [[ ${1} = init || -d ${CMAKE_USE_DIR}_build ]] && SUF="_build" || SUF="" 159 [[ ${1} = init || -d ${CMAKE_USE_DIR}_build ]] && SUF="_build" || SUF=""
136 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}${SUF}" 160 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}${SUF}"
137 161
138 fi 162 fi
139 echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\"" 163 echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\""
198# Based on use_enable. See ebuild(5). 222# Based on use_enable. See ebuild(5).
199# 223#
200# `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
201# and -DHAVE_FOO=OFF if it is disabled. 225# and -DHAVE_FOO=OFF if it is disabled.
202cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; } 226cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; }
203
204# @FUNCTION: cmake-utils_has
205# @DESCRIPTION:
206# Deprecated, use cmake-utils_use_has, kept now for backcompat.
207cmake-utils_has() { ewarn "QA notice: using deprecated ${FUNCNAME} call, use cmake-utils_use_has instead." ; _use_me_now HAVE_ "$@" ; }
208 227
209# @FUNCTION: cmake-utils_use 228# @FUNCTION: cmake-utils_use
210# @USAGE: <USE flag> [flag name] 229# @USAGE: <USE flag> [flag name]
211# @DESCRIPTION: 230# @DESCRIPTION:
212# Based on use_enable. See ebuild(5). 231# Based on use_enable. See ebuild(5).
226 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_BUILD_TYPE.*)/{s/^/#IGNORE /g}' {} + \ 245 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_BUILD_TYPE.*)/{s/^/#IGNORE /g}' {} + \
227 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \ 246 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \
228 || die "${LINENO}: failed to disable hardcoded settings" 247 || die "${LINENO}: failed to disable hardcoded settings"
229 248
230 # NOTE Append some useful summary here 249 # NOTE Append some useful summary here
231 echo ' 250 cat >> CMakeLists.txt <<- _EOF_
251
232MESSAGE(STATUS "<<< Gentoo configuration >>> 252 MESSAGE(STATUS "<<< Gentoo configuration >>>
233Build type: ${CMAKE_BUILD_TYPE} 253 Build type: ${CMAKE_BUILD_TYPE}
234Install path: ${CMAKE_INSTALL_PREFIX}\n")' >> CMakeLists.txt 254 Install path: ${CMAKE_INSTALL_PREFIX}\n")
255 _EOF_
235} 256}
236 257
237# @FUNCTION: cmake-utils_src_configure 258# @FUNCTION: enable_cmake-utils_src_configure
238# @DESCRIPTION: 259# @DESCRIPTION:
239# General function for configuring with cmake. Default behaviour is to start an 260# General function for configuring with cmake. Default behaviour is to start an
240# out-of-source build. 261# out-of-source build.
241cmake-utils_src_configure() { 262enable_cmake-utils_src_configure() {
242 debug-print-function ${FUNCNAME} "$@" 263 debug-print-function ${FUNCNAME} "$@"
243 264
244 _check_build_dir init 265 _check_build_dir init
245 266
246 # check if CMakeLists.txt exist and if no then die 267 # check if CMakeLists.txt exist and if no then die
247 if [[ ! -e "${CMAKE_USE_DIR}"/CMakeLists.txt ]] ; then 268 if [[ ! -e ${CMAKE_USE_DIR}/CMakeLists.txt ]] ; then
248 eerror "I was unable to locate CMakeLists.txt under:" 269 eerror "I was unable to locate CMakeLists.txt under:"
249 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\"" 270 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\""
250 eerror "You should consider not inheriting the cmake eclass." 271 eerror "You should consider not inheriting the cmake eclass."
251 die "FATAL: Unable to find CMakeLists.txt" 272 die "FATAL: Unable to find CMakeLists.txt"
252 fi 273 fi
253 274
254 # Remove dangerous things. 275 # Remove dangerous things.
255 _modify-cmakelists 276 _modify-cmakelists
277
278 # Fix xdg collision with sandbox
279 export XDG_CONFIG_HOME="${T}"
256 280
257 # @SEE CMAKE_BUILD_TYPE 281 # @SEE CMAKE_BUILD_TYPE
258 if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then 282 if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then
259 # Handle release builds 283 # Handle release builds
260 if ! has debug ${IUSE//+} || ! use debug; then 284 if ! has debug ${IUSE//+} || ! use debug; then
261 append-cppflags -DNDEBUG 285 append-cppflags -DNDEBUG
262 fi 286 fi
263 fi 287 fi
264 288
265 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS) 289 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
266 local build_rules="${TMPDIR}"/gentoo_rules.cmake 290 local build_rules=${T}/gentoo_rules.cmake
267cat > ${build_rules} << _EOF_ 291 cat > "${build_rules}" <<- _EOF_
268SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE) 292 SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
269SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE) 293 SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
270SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE) 294 SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
271SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE) 295 SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE)
272_EOF_ 296 _EOF_
297
298 if use prefix; then
299 cat >> "${build_rules}" <<- _EOF_
300 # in Prefix we need rpath and must ensure cmake gets our default linker path
301 # right ... except for Darwin hosts
302 IF (NOT APPLE)
303 SET (CMAKE_SKIP_RPATH OFF CACHE BOOL "" FORCE)
304 SET (CMAKE_PLATFORM_REQUIRED_RUNTIME_PATH "${EPREFIX}/usr/${CHOST}/lib/gcc;${EPREFIX}/usr/${CHOST}/lib;${EPREFIX}/usr/$(get_libdir);${EPREFIX}/$(get_libdir)"
305 CACHE STRING "" FORCE)
306 ENDIF (NOT APPLE)
307 _EOF_
308 fi
309
310 # Common configure parameters (invariants)
311 local common_config=${T}/gentoo_common_config.cmake
312 local libdir=$(get_libdir)
313 cat > "${common_config}" <<- _EOF_
314 SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
315 _EOF_
316 [[ -n ${CMAKE_NO_COLOR} ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}"
317
318 # Convert mycmakeargs to an array, for backwards compatibility
319 if [[ $(declare -p mycmakeargs 2>&-) != "declare -a mycmakeargs="* ]]; then
320 mycmakeargs=(${mycmakeargs})
321 fi
322
323 has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=
273 324
274 # Common configure parameters (overridable) 325 # Common configure parameters (overridable)
275 # NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable 326 # NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable
276 # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect. 327 # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect.
277 local cmakeargs=" 328 local cmakeargs=(
329 -C "${common_config}"
278 -DCMAKE_INSTALL_PREFIX=${PREFIX:-/usr} 330 -DCMAKE_INSTALL_PREFIX="${PREFIX:-${EPREFIX}/usr}"
279 ${mycmakeargs} 331 "${mycmakeargs[@]}"
280 -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} 332 -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}"
281 -DCMAKE_INSTALL_DO_STRIP=OFF 333 -DCMAKE_INSTALL_DO_STRIP=OFF
282 -DCMAKE_USER_MAKE_RULES_OVERRIDE=${build_rules}" 334 -DCMAKE_USER_MAKE_RULES_OVERRIDE="${build_rules}"
283 335 )
284 # Common configure parameters (invariants)
285 local common_config="${TMPDIR}"/gentoo_common_config.cmake
286 local libdir=$(get_libdir)
287cat > ${common_config} << _EOF_
288SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
289_EOF_
290 [[ -n ${CMAKE_NO_COLOR} ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> ${common_config}
291 cmakeargs="-C ${common_config} ${cmakeargs}"
292 336
293 mkdir -p "${CMAKE_BUILD_DIR}" 337 mkdir -p "${CMAKE_BUILD_DIR}"
294 pushd "${CMAKE_BUILD_DIR}" > /dev/null 338 pushd "${CMAKE_BUILD_DIR}" > /dev/null
295 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is $cmakeargs" 339 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is ${cmakeargs[*]}"
340 echo cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}"
296 cmake ${cmakeargs} "${CMAKE_USE_DIR}" || die "cmake failed" 341 cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" || die "cmake failed"
297 342
298 popd > /dev/null 343 popd > /dev/null
299} 344}
300 345
301# @FUNCTION: cmake-utils_src_compile 346# @FUNCTION: enable_cmake-utils_src_compile
302# @DESCRIPTION: 347# @DESCRIPTION:
303# General function for compiling with cmake. Default behaviour is to check for 348# General function for compiling with cmake. Default behaviour is to check for
304# EAPI and respectively to configure as well or just compile. 349# EAPI and respectively to configure as well or just compile.
305cmake-utils_src_compile() { 350enable_cmake-utils_src_compile() {
306 debug-print-function ${FUNCNAME} "$@" 351 debug-print-function ${FUNCNAME} "$@"
307 352
308 has src_configure ${EXPF} || cmake-utils_src_configure 353 has src_configure ${CMAKE_EXPF} || cmake-utils_src_configure
309 cmake-utils_src_make "$@" 354 cmake-utils_src_make "$@"
310} 355}
311 356
312# @FUNCTION: cmake-utils_src_configurein
313# @DESCRIPTION:
314# Deprecated
315cmake-utils_src_configurein() {
316 ewarn "QA notice: using deprecated ${FUNCNAME} call, set CMAKE_IN_SOURCE_BUILD=1 instead."
317 cmake-utils_src_configure
318}
319
320# @FUNCTION: cmake-utils_src_configureout
321# @DESCRIPTION:
322# Deprecated
323cmake-utils_src_configureout() {
324 ewarn "QA notice: using deprecated ${FUNCNAME} call, out of source build is enabled by default."
325 cmake-utils_src_configure
326}
327
328# @FUNCTION: cmake-utils_src_make 357# @FUNCTION: cmake-utils_src_make
329# @DESCRIPTION: 358# @DESCRIPTION:
330# Function for building the package. Automatically detects the build type. 359# Function for building the package. Automatically detects the build type.
331# All arguments are passed to emake: 360# All arguments are passed to emake
332cmake-utils_src_make() { 361cmake-utils_src_make() {
333 debug-print-function ${FUNCNAME} "$@" 362 debug-print-function ${FUNCNAME} "$@"
334 363
335 _check_build_dir 364 _check_build_dir
336 pushd "${CMAKE_BUILD_DIR}" &> /dev/null 365 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
342 emake "$@" || die "Make failed!" 371 emake "$@" || die "Make failed!"
343 fi 372 fi
344 popd &> /dev/null 373 popd &> /dev/null
345} 374}
346 375
347# @FUNCTION: cmake-utils_src_install 376# @FUNCTION: enable_cmake-utils_src_install
348# @DESCRIPTION: 377# @DESCRIPTION:
349# Function for installing the package. Automatically detects the build type. 378# Function for installing the package. Automatically detects the build type.
350cmake-utils_src_install() { 379enable_cmake-utils_src_install() {
351 debug-print-function ${FUNCNAME} "$@" 380 debug-print-function ${FUNCNAME} "$@"
352 381
353 _check_build_dir 382 _check_build_dir
354 pushd "${CMAKE_BUILD_DIR}" &> /dev/null 383 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
355 emake install DESTDIR="${D}" || die "Make install failed" 384 emake install DESTDIR="${D}" || die "Make install failed"
358 # Manual document installation 387 # Manual document installation
359 [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; } 388 [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; }
360 [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; } 389 [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; }
361} 390}
362 391
363# @FUNCTION: cmake-utils_src_test 392# @FUNCTION: enable_cmake-utils_src_test
364# @DESCRIPTION: 393# @DESCRIPTION:
365# Function for testing the package. Automatically detects the build type. 394# Function for testing the package. Automatically detects the build type.
366cmake-utils_src_test() { 395enable_cmake-utils_src_test() {
367 debug-print-function ${FUNCNAME} "$@" 396 debug-print-function ${FUNCNAME} "$@"
368 397
369 _check_build_dir 398 _check_build_dir
370 pushd "${CMAKE_BUILD_DIR}" &> /dev/null 399 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
371 # Standard implementation of src_test 400 # Standard implementation of src_test
382 else 411 else
383 einfo ">>> Test phase [none]: ${CATEGORY}/${PF}" 412 einfo ">>> Test phase [none]: ${CATEGORY}/${PF}"
384 fi 413 fi
385 popd &> /dev/null 414 popd &> /dev/null
386} 415}
416
417## Wrappers for calls bellow this line
418# @FUNCTION: cmake-utils_src_configure
419# @DESCRIPTION:
420# Wrapper for detection if we want to run enable_ prefixed function with same name
421# unconditionaly or only when some useflag is enabled.
422cmake-utils_src_configure() {
423 _execute_optionaly "src_configure"
424}
425
426# @FUNCTION: cmake-utils_src_compile
427# @DESCRIPTION:
428# Wrapper for detection if we want to run enable_ prefixed function with same name
429# unconditionaly or only when some useflag is enabled.
430cmake-utils_src_compile() {
431 _execute_optionaly "src_compile"
432}
433
434# @FUNCTION: cmake-utils_src_install
435# @DESCRIPTION:
436# Wrapper for detection if we want to run enable_ prefixed function with same name
437# unconditionaly or only when some useflag is enabled.
438cmake-utils_src_install() {
439 _execute_optionaly "src_install"
440}
441
442# @FUNCTION: cmake-utils_src_test
443# @DESCRIPTION:
444# Wrapper for detection if we want to run enable_ prefixed function with same name
445# unconditionaly or only when some useflag is enabled.
446cmake-utils_src_test() {
447 _execute_optionaly "src_test"
448}
449
450
451_execute_optionaly() {
452 local phase="$1"
453 if [[ ${WANT_CMAKE} = always ]]; then
454 enable_cmake-utils_${phase}
455 else
456 use ${WANT_CMAKE} && enable_cmake-utils_${phase}
457 fi
458}

Legend:
Removed from v.1.28  
changed lines
  Added in v.1.36

  ViewVC Help
Powered by ViewVC 1.1.20