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

Contents of /eclass/cmake-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.54 - (show annotations) (download)
Sat Jun 26 17:55:59 2010 UTC (4 years ago) by reavertm
Branch: MAIN
Changes since 1.53: +2 -2 lines
Properly handle NOCOLOR variable

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.53 2010/06/21 16:39:49 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@gentoo.org>
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 is base.eclass(5) wrapper that makes creating ebuilds for
18 # cmake-based packages much easier.
19 # It provides all inherited features (DOCS, HTML_DOCS, PATCHES) along with out-of-source
20 # builds (default), in-source builds and an implementation of the well-known use_enable
21 # and use_with 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_VERSION
32 # @DESCRIPTION:
33 # Specify the minimum allowable version of cmake. Defaults to 2.6.2-r1
34 CMAKE_MIN_VERSION="${CMAKE_MIN_VERSION:-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_VERSION}"
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: PREFIX
105 # @DESCRIPTION:
106 # Eclass respects PREFIX variable, though it's not recommended way to set
107 # install/lib/bin prefixes.
108 # Use -DCMAKE_INSTALL_PREFIX=... CMake variable instead.
109
110 # @ECLASS-VARIABLE: CMAKE_IN_SOURCE_BUILD
111 # @DESCRIPTION:
112 # Set to enable in-source build.
113
114 # @ECLASS-VARIABLE: CMAKE_VERBOSE
115 # @DESCRIPTION:
116 # Set to enable verbose messages during compilation.
117
118 # @ECLASS-VARIABLE: CMAKE_BUILD_TYPE
119 # @DESCRIPTION:
120 # Set to override default CMAKE_BUILD_TYPE. Only useful for packages
121 # known to make use of "if (CMAKE_BUILD_TYPE MATCHES xxx)".
122 # If about to be set - needs to be set before invoking cmake-utils_src_configure.
123 # You usualy do *NOT* want nor need to set it as it pulls CMake default build-type
124 # specific compiler flags overriding make.conf.
125 : ${CMAKE_BUILD_TYPE:=Gentoo}
126
127 # Determine using IN or OUT source build
128 _check_build_dir() {
129 # @ECLASS-VARIABLE: CMAKE_USE_DIR
130 # @DESCRIPTION:
131 # Sets the directory where we are working with cmake.
132 # For example when application uses autotools and only one
133 # plugin needs to be done by cmake.
134 # By default it uses ${S}.
135 : ${CMAKE_USE_DIR:=${S}}
136
137 # @ECLASS-VARIABLE: CMAKE_BUILD_DIR
138 # @DESCRIPTION:
139 # Specify the build directory where all cmake processed
140 # files should be located.
141 #
142 # For installing binary doins "${CMAKE_BUILD_DIR}/${PN}"
143 if [[ -n ${CMAKE_IN_SOURCE_BUILD} ]]; then
144 # we build in source dir
145 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}"
146 elif [[ ${CMAKE_USE_DIR} = ${WORKDIR} ]]; then
147 # out of tree build, but with $S=$WORKDIR, see bug #273949 for reason.
148 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}/build"
149 else
150 # regular out of tree build
151 [[ ${1} = init || -d ${CMAKE_USE_DIR}_build ]] && SUF="_build" || SUF=""
152 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}${SUF}"
153 fi
154 echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\""
155 }
156 # @FUNCTION: cmake-utils_use_with
157 # @USAGE: <USE flag> [flag name]
158 # @DESCRIPTION:
159 # Based on use_with. See ebuild(5).
160 #
161 # `cmake-utils_use_with foo FOO` echoes -DWITH_FOO=ON if foo is enabled
162 # and -DWITH_FOO=OFF if it is disabled.
163 cmake-utils_use_with() { _use_me_now WITH_ "$@" ; }
164
165 # @FUNCTION: cmake-utils_use_enable
166 # @USAGE: <USE flag> [flag name]
167 # @DESCRIPTION:
168 # Based on use_enable. See ebuild(5).
169 #
170 # `cmake-utils_use_enable foo FOO` echoes -DENABLE_FOO=ON if foo is enabled
171 # and -DENABLE_FOO=OFF if it is disabled.
172 cmake-utils_use_enable() { _use_me_now ENABLE_ "$@" ; }
173
174 # @FUNCTION: cmake-utils_use_disable
175 # @USAGE: <USE flag> [flag name]
176 # @DESCRIPTION:
177 # Based on inversion of use_enable. See ebuild(5).
178 #
179 # `cmake-utils_use_enable foo FOO` echoes -DDISABLE_FOO=OFF if foo is enabled
180 # and -DDISABLE_FOO=ON if it is disabled.
181 cmake-utils_use_disable() { _use_me_now_inverted DISABLE_ "$@" ; }
182
183 # @FUNCTION: cmake-utils_use_no
184 # @USAGE: <USE flag> [flag name]
185 # @DESCRIPTION:
186 # Based on use_disable. See ebuild(5).
187 #
188 # `cmake-utils_use_no foo FOO` echoes -DNO_FOO=OFF if foo is enabled
189 # and -DNO_FOO=ON if it is disabled.
190 cmake-utils_use_no() { _use_me_now_inverted NO_ "$@" ; }
191
192 # @FUNCTION: cmake-utils_use_want
193 # @USAGE: <USE flag> [flag name]
194 # @DESCRIPTION:
195 # Based on use_enable. See ebuild(5).
196 #
197 # `cmake-utils_use_want foo FOO` echoes -DWANT_FOO=ON if foo is enabled
198 # and -DWANT_FOO=OFF if it is disabled.
199 cmake-utils_use_want() { _use_me_now WANT_ "$@" ; }
200
201 # @FUNCTION: cmake-utils_use_build
202 # @USAGE: <USE flag> [flag name]
203 # @DESCRIPTION:
204 # Based on use_enable. See ebuild(5).
205 #
206 # `cmake-utils_use_build foo FOO` echoes -DBUILD_FOO=ON if foo is enabled
207 # and -DBUILD_FOO=OFF if it is disabled.
208 cmake-utils_use_build() { _use_me_now BUILD_ "$@" ; }
209
210 # @FUNCTION: cmake-utils_use_has
211 # @USAGE: <USE flag> [flag name]
212 # @DESCRIPTION:
213 # Based on use_enable. See ebuild(5).
214 #
215 # `cmake-utils_use_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled
216 # and -DHAVE_FOO=OFF if it is disabled.
217 cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; }
218
219 # @FUNCTION: cmake-utils_use
220 # @USAGE: <USE flag> [flag name]
221 # @DESCRIPTION:
222 # Based on use_enable. See ebuild(5).
223 #
224 # `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled
225 # and -DFOO=OFF if it is disabled.
226 cmake-utils_use() { _use_me_now "" "$@" ; }
227
228 # Internal function for modifying hardcoded definitions.
229 # Removes dangerous definitions that override Gentoo settings.
230 _modify-cmakelists() {
231 debug-print-function ${FUNCNAME} "$@"
232
233 # Comment out all set (<some_should_be_user_defined_variable> value)
234 # TODO Add QA checker - inform when variable being checked for below is set in CMakeLists.txt
235 find "${CMAKE_USE_DIR}" -name CMakeLists.txt \
236 -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_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \
238 || die "${LINENO}: failed to disable hardcoded settings"
239
240 # NOTE Append some useful summary here
241 cat >> CMakeLists.txt <<- _EOF_
242
243 MESSAGE(STATUS "<<< Gentoo configuration >>>
244 Build type \${CMAKE_BUILD_TYPE}
245 Install path \${CMAKE_INSTALL_PREFIX}
246 Compiler flags:
247 C \${CMAKE_C_FLAGS}
248 C++ \${CMAKE_CXX_FLAGS}
249 Linker flags:
250 Executable \${CMAKE_EXE_LINKER_FLAGS}
251 Module \${CMAKE_MODULE_LINKER_FLAGS}
252 Shared \${CMAKE_SHARED_LINKER_FLAGS}\n")
253 _EOF_
254 }
255
256 enable_cmake-utils_src_configure() {
257 debug-print-function ${FUNCNAME} "$@"
258
259 _check_build_dir init
260
261 # check if CMakeLists.txt exist and if no then die
262 if [[ ! -e ${CMAKE_USE_DIR}/CMakeLists.txt ]] ; then
263 eerror "Unable to locate CMakeLists.txt under:"
264 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\""
265 eerror "Consider not inheriting the cmake eclass."
266 die "FATAL: Unable to find CMakeLists.txt"
267 fi
268
269 # Remove dangerous things.
270 _modify-cmakelists
271
272 # Fix xdg collision with sandbox
273 export XDG_CONFIG_HOME="${T}"
274
275 # @SEE CMAKE_BUILD_TYPE
276 if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then
277 # Handle release builds
278 if ! has debug ${IUSE//+} || ! use debug; then
279 append-cppflags -DNDEBUG
280 fi
281 fi
282
283 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
284 local build_rules=${T}/gentoo_rules.cmake
285 cat > "${build_rules}" <<- _EOF_
286 SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
287 SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
288 SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
289 SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE)
290 _EOF_
291
292 if use prefix; then
293 cat >> "${build_rules}" <<- _EOF_
294 # in Prefix we need rpath and must ensure cmake gets our default linker path
295 # right ... except for Darwin hosts
296 IF (NOT APPLE)
297 SET (CMAKE_SKIP_RPATH OFF CACHE BOOL "" FORCE)
298 SET (CMAKE_PLATFORM_REQUIRED_RUNTIME_PATH "${EPREFIX}/usr/${CHOST}/lib/gcc;${EPREFIX}/usr/${CHOST}/lib;${EPREFIX}/usr/$(get_libdir);${EPREFIX}/$(get_libdir)"
299 CACHE STRING "" FORCE)
300 ENDIF (NOT APPLE)
301 _EOF_
302 fi
303
304 # Common configure parameters (invariants)
305 local common_config=${T}/gentoo_common_config.cmake
306 local libdir=$(get_libdir)
307 cat > "${common_config}" <<- _EOF_
308 SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
309 SET (CMAKE_INSTALL_LIBDIR ${libdir} CACHE PATH "Output directory for libraries")
310 _EOF_
311 [[ "${NOCOLOR}" = true || "${NOCOLOR}" = yes ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}"
312
313 # Convert mycmakeargs to an array, for backwards compatibility
314 # Make the array a local variable since <=portage-2.1.6.x does not
315 # support global arrays (see bug #297255).
316 if [[ $(declare -p mycmakeargs 2>&-) != "declare -a mycmakeargs="* ]]; then
317 local mycmakeargs_local=(${mycmakeargs})
318 else
319 local mycmakeargs_local=("${mycmakeargs[@]}")
320 fi
321
322 has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=
323
324 # Common configure parameters (overridable)
325 # NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable
326 # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect.
327 local cmakeargs=(
328 -C "${common_config}"
329 -DCMAKE_INSTALL_PREFIX="${EPREFIX}${PREFIX:-/usr}"
330 "${mycmakeargs_local[@]}"
331 -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}"
332 -DCMAKE_INSTALL_DO_STRIP=OFF
333 -DCMAKE_USER_MAKE_RULES_OVERRIDE="${build_rules}"
334 "${MYCMAKEARGS}"
335 )
336
337 mkdir -p "${CMAKE_BUILD_DIR}"
338 pushd "${CMAKE_BUILD_DIR}" > /dev/null
339 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is ${mycmakeargs_local[*]}"
340 echo cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}"
341 cmake "${cmakeargs[@]}" "${CMAKE_USE_DIR}" || die "cmake failed"
342
343 popd > /dev/null
344 }
345
346 enable_cmake-utils_src_compile() {
347 debug-print-function ${FUNCNAME} "$@"
348
349 has src_configure ${CMAKE_EXPF} || cmake-utils_src_configure
350 cmake-utils_src_make "$@"
351 }
352
353 # @FUNCTION: cmake-utils_src_make
354 # @DESCRIPTION:
355 # Function for building the package. Automatically detects the build type.
356 # All arguments are passed to emake
357 cmake-utils_src_make() {
358 debug-print-function ${FUNCNAME} "$@"
359
360 _check_build_dir
361 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
362 # first check if Makefile exist otherwise die
363 [[ -e Makefile ]] || die "Makefile not found. Error during configure stage."
364 if [[ -n ${CMAKE_VERBOSE} ]]; then
365 emake VERBOSE=1 "$@" || die "Make failed!"
366 else
367 emake "$@" || die "Make failed!"
368 fi
369 popd &> /dev/null
370 }
371
372 enable_cmake-utils_src_install() {
373 debug-print-function ${FUNCNAME} "$@"
374
375 _check_build_dir
376 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
377 base_src_install
378 popd &> /dev/null
379
380 # Backward compatibility, for non-array variables
381 if [[ -n "${DOCS}" ]] && [[ "$(declare -p DOCS 2>/dev/null 2>&1)" != "declare -a"* ]]; then
382 dodoc ${DOCS} || die "dodoc failed"
383 fi
384 if [[ -n "${HTML_DOCS}" ]] && [[ "$(declare -p HTML_DOCS 2>/dev/null 2>&1)" != "declare -a"* ]]; then
385 dohtml -r ${HTML_DOCS} || die "dohtml failed"
386 fi
387 }
388
389 enable_cmake-utils_src_test() {
390 debug-print-function ${FUNCNAME} "$@"
391
392 _check_build_dir
393 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
394 # Standard implementation of src_test
395 if emake -j1 check -n &> /dev/null; then
396 einfo ">>> Test phase [check]: ${CATEGORY}/${PF}"
397 if ! emake -j1 check; then
398 die "Make check failed. See above for details."
399 fi
400 elif emake -j1 test -n &> /dev/null; then
401 einfo ">>> Test phase [test]: ${CATEGORY}/${PF}"
402 if ! emake -j1 test; then
403 die "Make test failed. See above for details."
404 fi
405 else
406 einfo ">>> Test phase [none]: ${CATEGORY}/${PF}"
407 fi
408 popd &> /dev/null
409 }
410
411 # @FUNCTION: cmake-utils_src_configure
412 # @DESCRIPTION:
413 # General function for configuring with cmake. Default behaviour is to start an
414 # out-of-source build.
415 cmake-utils_src_configure() {
416 _execute_optionaly "src_configure" "$@"
417 }
418
419 # @FUNCTION: cmake-utils_src_compile
420 # @DESCRIPTION:
421 # General function for compiling with cmake. Default behaviour is to check for
422 # EAPI and respectively to configure as well or just compile.
423 # Automatically detects the build type. All arguments are passed to emake.
424 cmake-utils_src_compile() {
425 _execute_optionaly "src_compile" "$@"
426 }
427
428 # @FUNCTION: cmake-utils_src_install
429 # @DESCRIPTION:
430 # Function for installing the package. Automatically detects the build type.
431 cmake-utils_src_install() {
432 _execute_optionaly "src_install" "$@"
433 }
434
435 # @FUNCTION: cmake-utils_src_test
436 # @DESCRIPTION:
437 # Function for testing the package. Automatically detects the build type.
438 cmake-utils_src_test() {
439 _execute_optionaly "src_test" "$@"
440 }
441
442 # Optionally executes phases based on WANT_CMAKE variable/USE flag.
443 _execute_optionaly() {
444 local phase="$1" ; shift
445 if [[ ${WANT_CMAKE} = always ]]; then
446 enable_cmake-utils_${phase} "$@"
447 else
448 use ${WANT_CMAKE} && enable_cmake-utils_${phase} "$@"
449 fi
450 }

  ViewVC Help
Powered by ViewVC 1.1.20