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

Contents of /eclass/cmake-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.44 - (show annotations) (download)
Wed Jan 20 02:54:56 2010 UTC (4 years, 10 months ago) by abcd
Branch: MAIN
Changes since 1.43: +1 -2 lines
Drop workaround for bug in prefix's binutils-config

1 # Copyright 1999-2009 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.43 2010/01/11 17:02:49 scarabeus 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
158 fi
159 echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\""
160 }
161 # @FUNCTION: cmake-utils_use_with
162 # @USAGE: <USE flag> [flag name]
163 # @DESCRIPTION:
164 # Based on use_with. See ebuild(5).
165 #
166 # `cmake-utils_use_with foo FOO` echoes -DWITH_FOO=ON if foo is enabled
167 # and -DWITH_FOO=OFF if it is disabled.
168 cmake-utils_use_with() { _use_me_now WITH_ "$@" ; }
169
170 # @FUNCTION: cmake-utils_use_enable
171 # @USAGE: <USE flag> [flag name]
172 # @DESCRIPTION:
173 # Based on use_enable. See ebuild(5).
174 #
175 # `cmake-utils_use_enable foo FOO` echoes -DENABLE_FOO=ON if foo is enabled
176 # and -DENABLE_FOO=OFF if it is disabled.
177 cmake-utils_use_enable() { _use_me_now ENABLE_ "$@" ; }
178
179 # @FUNCTION: cmake-utils_use_disable
180 # @USAGE: <USE flag> [flag name]
181 # @DESCRIPTION:
182 # Based on inversion of use_enable. See ebuild(5).
183 #
184 # `cmake-utils_use_enable foo FOO` echoes -DDISABLE_FOO=OFF if foo is enabled
185 # and -DDISABLE_FOO=ON if it is disabled.
186 cmake-utils_use_disable() { _use_me_now_inverted DISABLE_ "$@" ; }
187
188 # @FUNCTION: cmake-utils_use_no
189 # @USAGE: <USE flag> [flag name]
190 # @DESCRIPTION:
191 # Based on use_disable. See ebuild(5).
192 #
193 # `cmake-utils_use_no foo FOO` echoes -DNO_FOO=OFF if foo is enabled
194 # and -DNO_FOO=ON if it is disabled.
195 cmake-utils_use_no() { _use_me_now_inverted NO_ "$@" ; }
196
197 # @FUNCTION: cmake-utils_use_want
198 # @USAGE: <USE flag> [flag name]
199 # @DESCRIPTION:
200 # Based on use_enable. See ebuild(5).
201 #
202 # `cmake-utils_use_want foo FOO` echoes -DWANT_FOO=ON if foo is enabled
203 # and -DWANT_FOO=OFF if it is disabled.
204 cmake-utils_use_want() { _use_me_now WANT_ "$@" ; }
205
206 # @FUNCTION: cmake-utils_use_build
207 # @USAGE: <USE flag> [flag name]
208 # @DESCRIPTION:
209 # Based on use_enable. See ebuild(5).
210 #
211 # `cmake-utils_use_build foo FOO` echoes -DBUILD_FOO=ON if foo is enabled
212 # and -DBUILD_FOO=OFF if it is disabled.
213 cmake-utils_use_build() { _use_me_now BUILD_ "$@" ; }
214
215 # @FUNCTION: cmake-utils_use_has
216 # @USAGE: <USE flag> [flag name]
217 # @DESCRIPTION:
218 # Based on use_enable. See ebuild(5).
219 #
220 # `cmake-utils_use_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled
221 # and -DHAVE_FOO=OFF if it is disabled.
222 cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; }
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_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \
243 || die "${LINENO}: failed to disable hardcoded settings"
244
245 # NOTE Append some useful summary here
246 cat >> CMakeLists.txt <<- _EOF_
247
248 MESSAGE(STATUS "<<< Gentoo configuration >>>
249 Build type: \${CMAKE_BUILD_TYPE}
250 Install path: \${CMAKE_INSTALL_PREFIX}\n")
251 _EOF_
252 }
253
254 # @FUNCTION: enable_cmake-utils_src_configure
255 # @DESCRIPTION:
256 # General function for configuring with cmake. Default behaviour is to start an
257 # out-of-source build.
258 enable_cmake-utils_src_configure() {
259 debug-print-function ${FUNCNAME} "$@"
260
261 _check_build_dir init
262
263 # check if CMakeLists.txt exist and if no then die
264 if [[ ! -e ${CMAKE_USE_DIR}/CMakeLists.txt ]] ; then
265 eerror "I was unable to locate CMakeLists.txt under:"
266 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\""
267 eerror "You should consider not inheriting the cmake eclass."
268 die "FATAL: Unable to find CMakeLists.txt"
269 fi
270
271 # Remove dangerous things.
272 _modify-cmakelists
273
274 # Fix xdg collision with sandbox
275 export XDG_CONFIG_HOME="${T}"
276
277 # @SEE CMAKE_BUILD_TYPE
278 if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then
279 # Handle release builds
280 if ! has debug ${IUSE//+} || ! use debug; then
281 append-cppflags -DNDEBUG
282 fi
283 fi
284
285 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
286 local build_rules=${T}/gentoo_rules.cmake
287 cat > "${build_rules}" <<- _EOF_
288 SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
289 SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
290 SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
291 SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE)
292 _EOF_
293
294 if use prefix; then
295 cat >> "${build_rules}" <<- _EOF_
296 # in Prefix we need rpath and must ensure cmake gets our default linker path
297 # right ... except for Darwin hosts
298 IF (NOT APPLE)
299 SET (CMAKE_SKIP_RPATH OFF CACHE BOOL "" FORCE)
300 SET (CMAKE_PLATFORM_REQUIRED_RUNTIME_PATH "${EPREFIX}/usr/${CHOST}/lib/gcc;${EPREFIX}/usr/${CHOST}/lib;${EPREFIX}/usr/$(get_libdir);${EPREFIX}/$(get_libdir)"
301 CACHE STRING "" FORCE)
302 ENDIF (NOT APPLE)
303 _EOF_
304 fi
305
306 # Common configure parameters (invariants)
307 local common_config=${T}/gentoo_common_config.cmake
308 local libdir=$(get_libdir)
309 cat > "${common_config}" <<- _EOF_
310 SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
311 _EOF_
312 [[ -n ${NOCOLOR} ]] || echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}"
313
314 # Convert mycmakeargs to an array, for backwards compatibility
315 # Make the array a local variable since <=portage-2.1.6.x does not
316 # support global arrays (see bug #297255).
317 if [[ $(declare -p mycmakeargs 2>&-) != "declare -a mycmakeargs="* ]]; then
318 local mycmakeargs_local=(${mycmakeargs})
319 else
320 local mycmakeargs_local=("${mycmakeargs[@]}")
321 fi
322
323 has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=
324
325 # Common configure parameters (overridable)
326 # NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable
327 # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect.
328 local cmakeargs=(
329 -C "${common_config}"
330 -DCMAKE_INSTALL_PREFIX="${EPREFIX}${PREFIX:-/usr}"
331 "${mycmakeargs_local[@]}"
332 -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}"
333 -DCMAKE_INSTALL_DO_STRIP=OFF
334 -DCMAKE_USER_MAKE_RULES_OVERRIDE="${build_rules}"
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 # @FUNCTION: enable_cmake-utils_src_compile
347 # @DESCRIPTION:
348 # General function for compiling with cmake. Default behaviour is to check for
349 # EAPI and respectively to configure as well or just compile.
350 enable_cmake-utils_src_compile() {
351 debug-print-function ${FUNCNAME} "$@"
352
353 has src_configure ${CMAKE_EXPF} || cmake-utils_src_configure
354 cmake-utils_src_make "$@"
355 }
356
357 # @FUNCTION: cmake-utils_src_make
358 # @DESCRIPTION:
359 # Function for building the package. Automatically detects the build type.
360 # All arguments are passed to emake
361 cmake-utils_src_make() {
362 debug-print-function ${FUNCNAME} "$@"
363
364 _check_build_dir
365 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
366 # first check if Makefile exist otherwise die
367 [[ -e Makefile ]] || die "Makefile not found. Error during configure stage."
368 if [[ -n ${CMAKE_VERBOSE} ]]; then
369 emake VERBOSE=1 "$@" || die "Make failed!"
370 else
371 emake "$@" || die "Make failed!"
372 fi
373 popd &> /dev/null
374 }
375
376 # @FUNCTION: enable_cmake-utils_src_install
377 # @DESCRIPTION:
378 # Function for installing the package. Automatically detects the build type.
379 enable_cmake-utils_src_install() {
380 debug-print-function ${FUNCNAME} "$@"
381
382 _check_build_dir
383 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
384 emake install DESTDIR="${D}" || die "Make install failed"
385 popd &> /dev/null
386
387 # Manual document installation
388 [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; }
389 [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; }
390 }
391
392 # @FUNCTION: enable_cmake-utils_src_test
393 # @DESCRIPTION:
394 # Function for testing the package. Automatically detects the build type.
395 enable_cmake-utils_src_test() {
396 debug-print-function ${FUNCNAME} "$@"
397
398 _check_build_dir
399 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
400 # Standard implementation of src_test
401 if emake -j1 check -n &> /dev/null; then
402 einfo ">>> Test phase [check]: ${CATEGORY}/${PF}"
403 if ! emake -j1 check; then
404 die "Make check failed. See above for details."
405 fi
406 elif emake -j1 test -n &> /dev/null; then
407 einfo ">>> Test phase [test]: ${CATEGORY}/${PF}"
408 if ! emake -j1 test; then
409 die "Make test failed. See above for details."
410 fi
411 else
412 einfo ">>> Test phase [none]: ${CATEGORY}/${PF}"
413 fi
414 popd &> /dev/null
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.
422 cmake-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.
430 cmake-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.
438 cmake-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.
446 cmake-utils_src_test() {
447 _execute_optionaly "src_test" "$@"
448 }
449
450
451 _execute_optionaly() {
452 local phase="$1" ; shift
453 if [[ ${WANT_CMAKE} = always ]]; then
454 enable_cmake-utils_${phase} "$@"
455 else
456 use ${WANT_CMAKE} && enable_cmake-utils_${phase} "$@"
457 fi
458 }

  ViewVC Help
Powered by ViewVC 1.1.20