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

Contents of /eclass/cmake-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.36 - (show annotations) (download)
Thu Dec 10 19:58:42 2009 UTC (4 years, 8 months ago) by abcd
Branch: MAIN
Changes since 1.35: +3 -2 lines
Silence an unneeded warning

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.35 2009/12/10 17:35:52 abcd 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@poczta.fm>
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_NO_COLOR
117 # @DESCRIPTION:
118 # Set to disable cmake output coloring.
119
120 # @ECLASS-VARIABLE: CMAKE_VERBOSE
121 # @DESCRIPTION:
122 # Set to enable verbose messages during compilation.
123
124 # @ECLASS-VARIABLE: CMAKE_BUILD_TYPE
125 # @DESCRIPTION:
126 # Set to override default CMAKE_BUILD_TYPE. Only useful for packages
127 # known to make use of "if (CMAKE_BUILD_TYPE MATCHES xxx)".
128 # If about to be set - needs to be set before invoking cmake-utils_src_configure.
129 # You usualy do *NOT* want nor need to set it as it pulls CMake default build-type
130 # specific compiler flags overriding make.conf.
131 : ${CMAKE_BUILD_TYPE:=Gentoo}
132
133 # @FUNCTION: _check_build_dir
134 # @DESCRIPTION:
135 # Determine using IN or OUT source build
136 _check_build_dir() {
137 # @ECLASS-VARIABLE: CMAKE_USE_DIR
138 # @DESCRIPTION:
139 # Sets the directory where we are working with cmake.
140 # For example when application uses autotools and only one
141 # plugin needs to be done by cmake.
142 # By default it uses ${S}.
143 : ${CMAKE_USE_DIR:=${S}}
144
145 # @ECLASS-VARIABLE: CMAKE_BUILD_DIR
146 # @DESCRIPTION:
147 # Specify the build directory where all cmake processed
148 # files should be located.
149 #
150 # For installing binary doins "${CMAKE_BUILD_DIR}/${PN}"
151 if [[ -n ${CMAKE_IN_SOURCE_BUILD} ]]; then
152 # we build in source dir
153 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}"
154 elif [[ ${CMAKE_USE_DIR} = ${WORKDIR} ]]; then
155 # out of tree build, but with $S=$WORKDIR, see bug #273949 for reason.
156 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}/build"
157 else
158 # regular out of tree build
159 [[ ${1} = init || -d ${CMAKE_USE_DIR}_build ]] && SUF="_build" || SUF=""
160 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}${SUF}"
161
162 fi
163 echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\""
164 }
165 # @FUNCTION: cmake-utils_use_with
166 # @USAGE: <USE flag> [flag name]
167 # @DESCRIPTION:
168 # Based on use_with. See ebuild(5).
169 #
170 # `cmake-utils_use_with foo FOO` echoes -DWITH_FOO=ON if foo is enabled
171 # and -DWITH_FOO=OFF if it is disabled.
172 cmake-utils_use_with() { _use_me_now WITH_ "$@" ; }
173
174 # @FUNCTION: cmake-utils_use_enable
175 # @USAGE: <USE flag> [flag name]
176 # @DESCRIPTION:
177 # Based on use_enable. See ebuild(5).
178 #
179 # `cmake-utils_use_enable foo FOO` echoes -DENABLE_FOO=ON if foo is enabled
180 # and -DENABLE_FOO=OFF if it is disabled.
181 cmake-utils_use_enable() { _use_me_now ENABLE_ "$@" ; }
182
183 # @FUNCTION: cmake-utils_use_disable
184 # @USAGE: <USE flag> [flag name]
185 # @DESCRIPTION:
186 # Based on inversion of use_enable. See ebuild(5).
187 #
188 # `cmake-utils_use_enable foo FOO` echoes -DDISABLE_FOO=OFF if foo is enabled
189 # and -DDISABLE_FOO=ON if it is disabled.
190 cmake-utils_use_disable() { _use_me_now_inverted DISABLE_ "$@" ; }
191
192 # @FUNCTION: cmake-utils_use_no
193 # @USAGE: <USE flag> [flag name]
194 # @DESCRIPTION:
195 # Based on use_disable. See ebuild(5).
196 #
197 # `cmake-utils_use_no foo FOO` echoes -DNO_FOO=OFF if foo is enabled
198 # and -DNO_FOO=ON if it is disabled.
199 cmake-utils_use_no() { _use_me_now_inverted NO_ "$@" ; }
200
201 # @FUNCTION: cmake-utils_use_want
202 # @USAGE: <USE flag> [flag name]
203 # @DESCRIPTION:
204 # Based on use_enable. See ebuild(5).
205 #
206 # `cmake-utils_use_want foo FOO` echoes -DWANT_FOO=ON if foo is enabled
207 # and -DWANT_FOO=OFF if it is disabled.
208 cmake-utils_use_want() { _use_me_now WANT_ "$@" ; }
209
210 # @FUNCTION: cmake-utils_use_build
211 # @USAGE: <USE flag> [flag name]
212 # @DESCRIPTION:
213 # Based on use_enable. See ebuild(5).
214 #
215 # `cmake-utils_use_build foo FOO` echoes -DBUILD_FOO=ON if foo is enabled
216 # and -DBUILD_FOO=OFF if it is disabled.
217 cmake-utils_use_build() { _use_me_now BUILD_ "$@" ; }
218
219 # @FUNCTION: cmake-utils_use_has
220 # @USAGE: <USE flag> [flag name]
221 # @DESCRIPTION:
222 # Based on use_enable. See ebuild(5).
223 #
224 # `cmake-utils_use_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled
225 # and -DHAVE_FOO=OFF if it is disabled.
226 cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; }
227
228 # @FUNCTION: cmake-utils_use
229 # @USAGE: <USE flag> [flag name]
230 # @DESCRIPTION:
231 # Based on use_enable. See ebuild(5).
232 #
233 # `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled
234 # and -DFOO=OFF if it is disabled.
235 cmake-utils_use() { _use_me_now "" "$@" ; }
236
237 # Internal function for modifying hardcoded definitions.
238 # Removes dangerous definitionts that override Gentoo settings.
239 _modify-cmakelists() {
240 debug-print-function ${FUNCNAME} "$@"
241
242 # Comment out all set (<some_should_be_user_defined_variable> value)
243 # TODO Add QA checker - inform when variable being checked for below is set in CMakeLists.txt
244 find "${CMAKE_USE_DIR}" -name CMakeLists.txt \
245 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_BUILD_TYPE.*)/{s/^/#IGNORE /g}' {} + \
246 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \
247 || die "${LINENO}: failed to disable hardcoded settings"
248
249 # NOTE Append some useful summary here
250 cat >> CMakeLists.txt <<- _EOF_
251
252 MESSAGE(STATUS "<<< Gentoo configuration >>>
253 Build type: ${CMAKE_BUILD_TYPE}
254 Install path: ${CMAKE_INSTALL_PREFIX}\n")
255 _EOF_
256 }
257
258 # @FUNCTION: enable_cmake-utils_src_configure
259 # @DESCRIPTION:
260 # General function for configuring with cmake. Default behaviour is to start an
261 # out-of-source build.
262 enable_cmake-utils_src_configure() {
263 debug-print-function ${FUNCNAME} "$@"
264
265 _check_build_dir init
266
267 # check if CMakeLists.txt exist and if no then die
268 if [[ ! -e ${CMAKE_USE_DIR}/CMakeLists.txt ]] ; then
269 eerror "I was unable to locate CMakeLists.txt under:"
270 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\""
271 eerror "You should consider not inheriting the cmake eclass."
272 die "FATAL: Unable to find CMakeLists.txt"
273 fi
274
275 # Remove dangerous things.
276 _modify-cmakelists
277
278 # Fix xdg collision with sandbox
279 export XDG_CONFIG_HOME="${T}"
280
281 # @SEE CMAKE_BUILD_TYPE
282 if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then
283 # Handle release builds
284 if ! has debug ${IUSE//+} || ! use debug; then
285 append-cppflags -DNDEBUG
286 fi
287 fi
288
289 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
290 local build_rules=${T}/gentoo_rules.cmake
291 cat > "${build_rules}" <<- _EOF_
292 SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
293 SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
294 SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
295 SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE)
296 _EOF_
297
298 if use prefix; then
299 cat >> "${build_rules}" <<- _EOF_
300 # in Prefix we need rpath and must ensure cmake gets our default linker path
301 # right ... except for Darwin hosts
302 IF (NOT APPLE)
303 SET (CMAKE_SKIP_RPATH OFF CACHE BOOL "" FORCE)
304 SET (CMAKE_PLATFORM_REQUIRED_RUNTIME_PATH "${EPREFIX}/usr/${CHOST}/lib/gcc;${EPREFIX}/usr/${CHOST}/lib;${EPREFIX}/usr/$(get_libdir);${EPREFIX}/$(get_libdir)"
305 CACHE STRING "" FORCE)
306 ENDIF (NOT APPLE)
307 _EOF_
308 fi
309
310 # Common configure parameters (invariants)
311 local common_config=${T}/gentoo_common_config.cmake
312 local libdir=$(get_libdir)
313 cat > "${common_config}" <<- _EOF_
314 SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
315 _EOF_
316 [[ -n ${CMAKE_NO_COLOR} ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}"
317
318 # Convert mycmakeargs to an array, for backwards compatibility
319 if [[ $(declare -p mycmakeargs 2>&-) != "declare -a mycmakeargs="* ]]; then
320 mycmakeargs=(${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="${PREFIX:-${EPREFIX}/usr}"
331 "${mycmakeargs[@]}"
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 ${cmakeargs[*]}"
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"
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