/[gentoo-x86]/eclass/cmake-utils.eclass
Gentoo

Contents of /eclass/cmake-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.50 - (show annotations) (download)
Fri Apr 30 23:41:11 2010 UTC (4 years, 2 months ago) by abcd
Branch: MAIN
Changes since 1.49: +8 -2 lines
Allow changing the minimum required cmake version

1 # Copyright 1999-2010 Gentoo Foundation
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 $
4
5 # @ECLASS: cmake-utils.eclass
6 # @MAINTAINER:
7 # kde@gentoo.org
8 #
9 # @CODE
10 # Tomáš Chvátal <scarabeus@gentoo.org>
11 # Maciej Mrozowski <reavertm@gmail.com>
12 # (undisclosed contributors)
13 # Original author: Zephyrus (zephyrus@mirach.it)
14 # @CODE
15 # @BLURB: common ebuild functions for cmake-based packages
16 # @DESCRIPTION:
17 # The cmake-utils eclass contains functions that make creating ebuilds for
18 # cmake-based packages much easier.
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
21 # functions for CMake.
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)
29 WANT_CMAKE="${WANT_CMAKE:-always}"
30
31 # @ECLASS-VARIABLE: CMAKE_MIN_VER
32 # @DESCRIPTION:
33 # Specify the minimum allowable version of cmake. Defaults to 2.6.2-r1
34 CMAKE_MIN_VER="${CMAKE_MIN_VER:-2.6.2-r1}"
35
36 CMAKEDEPEND=""
37 case ${WANT_CMAKE} in
38 always)
39 ;;
40 *)
41 IUSE+=" ${WANT_CMAKE}"
42 CMAKEDEPEND+="${WANT_CMAKE}? ( "
43 ;;
44 esac
45 inherit toolchain-funcs multilib flag-o-matic base
46
47 CMAKE_EXPF="src_compile src_test src_install"
48 case ${EAPI:-0} in
49 3|2) CMAKE_EXPF+=" src_configure" ;;
50 1|0) ;;
51 *) die "Unknown EAPI, Bug eclass maintainers." ;;
52 esac
53 EXPORT_FUNCTIONS ${CMAKE_EXPF}
54
55 : ${DESCRIPTION:="Based on the ${ECLASS} eclass"}
56
57 if [[ ${PN} != cmake ]]; then
58 CMAKEDEPEND+=">=dev-util/cmake-${CMAKE_MIN_VER}"
59 fi
60
61 CMAKEDEPEND+=" userland_GNU? ( >=sys-apps/findutils-4.4.0 )"
62
63 [[ ${WANT_CMAKE} = always ]] || CMAKEDEPEND+=" )"
64
65 DEPEND="${CMAKEDEPEND}"
66 unset CMAKEDEPEND
67
68 # Internal functions used by cmake-utils_use_*
69 _use_me_now() {
70 debug-print-function ${FUNCNAME} "$@"
71
72 local uper capitalised x
73 [[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]"
74 if [[ ! -z $3 ]]; then
75 # user specified the use name so use it
76 echo "-D$1$3=$(use $2 && echo ON || echo OFF)"
77 else
78 # use all various most used combinations
79 uper=$(echo ${2} | tr '[:lower:]' '[:upper:]')
80 capitalised=$(echo ${2} | sed 's/\<\(.\)\([^ ]*\)/\u\1\L\2/g')
81 for x in $2 $uper $capitalised; do
82 echo "-D$1$x=$(use $2 && echo ON || echo OFF) "
83 done
84 fi
85 }
86 _use_me_now_inverted() {
87 debug-print-function ${FUNCNAME} "$@"
88
89 local uper capitalised x
90 [[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]"
91 if [[ ! -z $3 ]]; then
92 # user specified the use name so use it
93 echo "-D$1$3=$(use $2 && echo OFF || echo ON)"
94 else
95 # use all various most used combinations
96 uper=$(echo ${2} | tr '[:lower:]' '[:upper:]')
97 capitalised=$(echo ${2} | sed 's/\<\(.\)\([^ ]*\)/\u\1\L\2/g')
98 for x in $2 $uper $capitalised; do
99 echo "-D$1$x=$(use $2 && echo OFF || echo ON) "
100 done
101 fi
102 }
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
119 # @DESCRIPTION:
120 # Set to enable in-source build.
121
122 # @ECLASS-VARIABLE: CMAKE_VERBOSE
123 # @DESCRIPTION:
124 # Set to enable verbose messages during compilation.
125
126 # @ECLASS-VARIABLE: CMAKE_BUILD_TYPE
127 # @DESCRIPTION:
128 # Set to override default CMAKE_BUILD_TYPE. Only useful for packages
129 # 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.
131 # You usualy do *NOT* want nor need to set it as it pulls CMake default build-type
132 # specific compiler flags overriding make.conf.
133 : ${CMAKE_BUILD_TYPE:=Gentoo}
134
135 # @FUNCTION: _check_build_dir
136 # @DESCRIPTION:
137 # Determine using IN or OUT source build
138 _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}}
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
154 # we build in source dir
155 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}"
156 elif [[ ${CMAKE_USE_DIR} = ${WORKDIR} ]]; then
157 # out of tree build, but with $S=$WORKDIR, see bug #273949 for reason.
158 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}/build"
159 else
160 # regular out of tree build
161 [[ ${1} = init || -d ${CMAKE_USE_DIR}_build ]] && SUF="_build" || SUF=""
162 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}${SUF}"
163 fi
164 echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\""
165 }
166 # @FUNCTION: cmake-utils_use_with
167 # @USAGE: <USE flag> [flag name]
168 # @DESCRIPTION:
169 # Based on use_with. See ebuild(5).
170 #
171 # `cmake-utils_use_with foo FOO` echoes -DWITH_FOO=ON if foo is enabled
172 # and -DWITH_FOO=OFF if it is disabled.
173 cmake-utils_use_with() { _use_me_now WITH_ "$@" ; }
174
175 # @FUNCTION: cmake-utils_use_enable
176 # @USAGE: <USE flag> [flag name]
177 # @DESCRIPTION:
178 # Based on use_enable. See ebuild(5).
179 #
180 # `cmake-utils_use_enable foo FOO` echoes -DENABLE_FOO=ON if foo is enabled
181 # and -DENABLE_FOO=OFF if it is disabled.
182 cmake-utils_use_enable() { _use_me_now ENABLE_ "$@" ; }
183
184 # @FUNCTION: cmake-utils_use_disable
185 # @USAGE: <USE flag> [flag name]
186 # @DESCRIPTION:
187 # Based on inversion of use_enable. See ebuild(5).
188 #
189 # `cmake-utils_use_enable foo FOO` echoes -DDISABLE_FOO=OFF if foo is enabled
190 # and -DDISABLE_FOO=ON if it is disabled.
191 cmake-utils_use_disable() { _use_me_now_inverted DISABLE_ "$@" ; }
192
193 # @FUNCTION: cmake-utils_use_no
194 # @USAGE: <USE flag> [flag name]
195 # @DESCRIPTION:
196 # Based on use_disable. See ebuild(5).
197 #
198 # `cmake-utils_use_no foo FOO` echoes -DNO_FOO=OFF if foo is enabled
199 # and -DNO_FOO=ON if it is disabled.
200 cmake-utils_use_no() { _use_me_now_inverted NO_ "$@" ; }
201
202 # @FUNCTION: cmake-utils_use_want
203 # @USAGE: <USE flag> [flag name]
204 # @DESCRIPTION:
205 # Based on use_enable. See ebuild(5).
206 #
207 # `cmake-utils_use_want foo FOO` echoes -DWANT_FOO=ON if foo is enabled
208 # and -DWANT_FOO=OFF if it is disabled.
209 cmake-utils_use_want() { _use_me_now WANT_ "$@" ; }
210
211 # @FUNCTION: cmake-utils_use_build
212 # @USAGE: <USE flag> [flag name]
213 # @DESCRIPTION:
214 # Based on use_enable. See ebuild(5).
215 #
216 # `cmake-utils_use_build foo FOO` echoes -DBUILD_FOO=ON if foo is enabled
217 # and -DBUILD_FOO=OFF if it is disabled.
218 cmake-utils_use_build() { _use_me_now BUILD_ "$@" ; }
219
220 # @FUNCTION: cmake-utils_use_has
221 # @USAGE: <USE flag> [flag name]
222 # @DESCRIPTION:
223 # Based on use_enable. See ebuild(5).
224 #
225 # `cmake-utils_use_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled
226 # and -DHAVE_FOO=OFF if it is disabled.
227 cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; }
228
229 # @FUNCTION: cmake-utils_use
230 # @USAGE: <USE flag> [flag name]
231 # @DESCRIPTION:
232 # Based on use_enable. See ebuild(5).
233 #
234 # `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled
235 # and -DFOO=OFF if it is disabled.
236 cmake-utils_use() { _use_me_now "" "$@" ; }
237
238 # Internal function for modifying hardcoded definitions.
239 # Removes dangerous definitions that override Gentoo settings.
240 _modify-cmakelists() {
241 debug-print-function ${FUNCNAME} "$@"
242
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
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}' {} + \
247 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \
248 || die "${LINENO}: failed to disable hardcoded settings"
249
250 # NOTE Append some useful summary here
251 cat >> CMakeLists.txt <<- _EOF_
252
253 MESSAGE(STATUS "<<< Gentoo configuration >>>
254 Build type \${CMAKE_BUILD_TYPE}
255 Install path \${CMAKE_INSTALL_PREFIX}
256 Compiler flags:
257 C \${CMAKE_C_FLAGS}
258 C++ \${CMAKE_CXX_FLAGS}
259 Linker flags:
260 Executable \${CMAKE_EXE_LINKER_FLAGS}
261 Module \${CMAKE_MODULE_LINKER_FLAGS}
262 Shared \${CMAKE_SHARED_LINKER_FLAGS}\n")
263 _EOF_
264 }
265
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.
270 enable_cmake-utils_src_configure() {
271 debug-print-function ${FUNCNAME} "$@"
272
273 _check_build_dir init
274
275 # check if CMakeLists.txt exist and if no then die
276 if [[ ! -e ${CMAKE_USE_DIR}/CMakeLists.txt ]] ; then
277 eerror "Unable to locate CMakeLists.txt under:"
278 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\""
279 eerror "Consider not inheriting the cmake eclass."
280 die "FATAL: Unable to find CMakeLists.txt"
281 fi
282
283 # Remove dangerous things.
284 _modify-cmakelists
285
286 # Fix xdg collision with sandbox
287 export XDG_CONFIG_HOME="${T}"
288
289 # @SEE CMAKE_BUILD_TYPE
290 if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then
291 # Handle release builds
292 if ! has debug ${IUSE//+} || ! use debug; then
293 append-cppflags -DNDEBUG
294 fi
295 fi
296
297 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
298 local build_rules=${T}/gentoo_rules.cmake
299 cat > "${build_rules}" <<- _EOF_
300 SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
301 SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
302 SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
303 SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE)
304 _EOF_
305
306 if use prefix; then
307 cat >> "${build_rules}" <<- _EOF_
308 # in Prefix we need rpath and must ensure cmake gets our default linker path
309 # right ... except for Darwin hosts
310 IF (NOT APPLE)
311 SET (CMAKE_SKIP_RPATH OFF CACHE BOOL "" FORCE)
312 SET (CMAKE_PLATFORM_REQUIRED_RUNTIME_PATH "${EPREFIX}/usr/${CHOST}/lib/gcc;${EPREFIX}/usr/${CHOST}/lib;${EPREFIX}/usr/$(get_libdir);${EPREFIX}/$(get_libdir)"
313 CACHE STRING "" FORCE)
314 ENDIF (NOT APPLE)
315 _EOF_
316 fi
317
318 # Common configure parameters (invariants)
319 local common_config=${T}/gentoo_common_config.cmake
320 local libdir=$(get_libdir)
321 cat > "${common_config}" <<- _EOF_
322 SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
323 SET (CMAKE_INSTALL_LIBDIR ${libdir} CACHE PATH "Output directory for libraries")
324 _EOF_
325 [[ -n ${NOCOLOR} ]] || echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}"
326
327 # Convert mycmakeargs to an array, for backwards compatibility
328 # Make the array a local variable since <=portage-2.1.6.x does not
329 # support global arrays (see bug #297255).
330 if [[ $(declare -p mycmakeargs 2>&-) != "declare -a mycmakeargs="* ]]; then
331 local mycmakeargs_local=(${mycmakeargs})
332 else
333 local mycmakeargs_local=("${mycmakeargs[@]}")
334 fi
335
336 has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=
337
338 # Common configure parameters (overridable)
339 # NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable
340 # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect.
341 local cmakeargs=(
342 -C "${common_config}"
343 -DCMAKE_INSTALL_PREFIX="${EPREFIX}${PREFIX:-/usr}"
344 "${mycmakeargs_local[@]}"
345 -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}"
346 -DCMAKE_INSTALL_DO_STRIP=OFF
347 -DCMAKE_USER_MAKE_RULES_OVERRIDE="${build_rules}"
348 "${MYCMAKEARGS}"
349 )
350
351 mkdir -p "${CMAKE_BUILD_DIR}"
352 pushd "${CMAKE_BUILD_DIR}" > /dev/null
353 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is ${mycmakeargs_local[*]}"
354 echo cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}"
355 cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" || die "cmake failed"
356
357 popd > /dev/null
358 }
359
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.
364 enable_cmake-utils_src_compile() {
365 debug-print-function ${FUNCNAME} "$@"
366
367 has src_configure ${CMAKE_EXPF} || cmake-utils_src_configure
368 cmake-utils_src_make "$@"
369 }
370
371 # @FUNCTION: cmake-utils_src_make
372 # @DESCRIPTION:
373 # Function for building the package. Automatically detects the build type.
374 # All arguments are passed to emake
375 cmake-utils_src_make() {
376 debug-print-function ${FUNCNAME} "$@"
377
378 _check_build_dir
379 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
380 # first check if Makefile exist otherwise die
381 [[ -e Makefile ]] || die "Makefile not found. Error during configure stage."
382 if [[ -n ${CMAKE_VERBOSE} ]]; then
383 emake VERBOSE=1 "$@" || die "Make failed!"
384 else
385 emake "$@" || die "Make failed!"
386 fi
387 popd &> /dev/null
388 }
389
390 # @FUNCTION: enable_cmake-utils_src_install
391 # @DESCRIPTION:
392 # Function for installing the package. Automatically detects the build type.
393 enable_cmake-utils_src_install() {
394 debug-print-function ${FUNCNAME} "$@"
395
396 _check_build_dir
397 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
398 emake install DESTDIR="${D}" || die "Make install failed"
399 popd &> /dev/null
400
401 # Manual document installation
402 [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; }
403 [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; }
404 }
405
406 # @FUNCTION: enable_cmake-utils_src_test
407 # @DESCRIPTION:
408 # Function for testing the package. Automatically detects the build type.
409 enable_cmake-utils_src_test() {
410 debug-print-function ${FUNCNAME} "$@"
411
412 _check_build_dir
413 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
414 # Standard implementation of src_test
415 if emake -j1 check -n &> /dev/null; then
416 einfo ">>> Test phase [check]: ${CATEGORY}/${PF}"
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
429 }
430
431 ## Wrappers for calls bellow this line
432 # @FUNCTION: cmake-utils_src_configure
433 # @DESCRIPTION:
434 # Wrapper for detection if we want to run enable_ prefixed function with same name
435 # unconditionaly or only when some useflag is enabled.
436 cmake-utils_src_configure() {
437 _execute_optionaly "src_configure" "$@"
438 }
439
440 # @FUNCTION: cmake-utils_src_compile
441 # @DESCRIPTION:
442 # Wrapper for detection if we want to run enable_ prefixed function with same name
443 # unconditionaly or only when some useflag is enabled.
444 cmake-utils_src_compile() {
445 _execute_optionaly "src_compile" "$@"
446 }
447
448 # @FUNCTION: cmake-utils_src_install
449 # @DESCRIPTION:
450 # Wrapper for detection if we want to run enable_ prefixed function with same name
451 # unconditionaly or only when some useflag is enabled.
452 cmake-utils_src_install() {
453 _execute_optionaly "src_install" "$@"
454 }
455
456 # @FUNCTION: cmake-utils_src_test
457 # @DESCRIPTION:
458 # Wrapper for detection if we want to run enable_ prefixed function with same name
459 # unconditionaly or only when some useflag is enabled.
460 cmake-utils_src_test() {
461 _execute_optionaly "src_test" "$@"
462 }
463
464
465 _execute_optionaly() {
466 local phase="$1" ; shift
467 if [[ ${WANT_CMAKE} = always ]]; then
468 enable_cmake-utils_${phase} "$@"
469 else
470 use ${WANT_CMAKE} && enable_cmake-utils_${phase} "$@"
471 fi
472 }

  ViewVC Help
Powered by ViewVC 1.1.20