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

Contents of /eclass/cmake-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.49 - (show annotations) (download)
Sat Apr 10 02:20:59 2010 UTC (4 years, 3 months ago) by reavertm
Branch: MAIN
Changes since 1.48: +18 -12 lines
Display compiler and linker flags - a lousy compromise between excessive verbosity and hiding relevant information

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

  ViewVC Help
Powered by ViewVC 1.1.20