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

Contents of /eclass/cmake-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.59 - (show annotations) (download)
Thu Sep 16 16:04:11 2010 UTC (3 years, 10 months ago) by reavertm
Branch: MAIN
Changes since 1.58: +3 -8 lines
Allow setting CMAKE_BUILD_DIR (can be utilized in some exotic circumstances)

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

  ViewVC Help
Powered by ViewVC 1.1.20