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

Contents of /eclass/cmake-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.32 - (show annotations) (download)
Tue Oct 27 14:16:49 2009 UTC (4 years, 8 months ago) by scarabeus
Branch: MAIN
Changes since 1.31: +81 -39 lines
Sync cmake-utils and kde eclasses with kde-testing overlays.
Renamed WANT_CMAKE -> CMAKE_REQUIRED in kde eclasses
fixed koffice2.0 support in kde eclasses
Added WANT_CMAKE into cmake-utils eclass, where it brings possibility to depend on cmake only when some useflag is required.
Used with WANT_CMAKE="variable", where variable is the useflag (its autoadded to IUSE too.)

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.30 2009/08/08 20:08:02 arfrever 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 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 echo '
251 MESSAGE(STATUS "<<< Gentoo configuration >>>
252 Build type: ${CMAKE_BUILD_TYPE}
253 Install path: ${CMAKE_INSTALL_PREFIX}\n")' >> CMakeLists.txt
254 }
255
256 # @FUNCTION: enable_cmake-utils_src_configure
257 # @DESCRIPTION:
258 # General function for configuring with cmake. Default behaviour is to start an
259 # out-of-source build.
260 enable_cmake-utils_src_configure() {
261 debug-print-function ${FUNCNAME} "$@"
262
263 _check_build_dir init
264
265 # check if CMakeLists.txt exist and if no then die
266 if [[ ! -e "${CMAKE_USE_DIR}"/CMakeLists.txt ]] ; then
267 eerror "I was unable to locate CMakeLists.txt under:"
268 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\""
269 eerror "You should consider not inheriting the cmake eclass."
270 die "FATAL: Unable to find CMakeLists.txt"
271 fi
272
273 # Remove dangerous things.
274 _modify-cmakelists
275
276 # Fix xdg collision with sandbox
277 export XDG_CONFIG_HOME="${T}"
278
279 # @SEE CMAKE_BUILD_TYPE
280 if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then
281 # Handle release builds
282 if ! has debug ${IUSE//+} || ! use debug; then
283 append-cppflags -DNDEBUG
284 fi
285 fi
286
287 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
288 local build_rules="${TMPDIR}"/gentoo_rules.cmake
289 cat > ${build_rules} << _EOF_
290 SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
291 SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
292 SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
293 SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE)
294 _EOF_
295
296 # Common configure parameters (overridable)
297 # NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable
298 # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect.
299 local cmakeargs="
300 -DCMAKE_INSTALL_PREFIX=${PREFIX:-/usr}
301 ${mycmakeargs}
302 -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
303 -DCMAKE_INSTALL_DO_STRIP=OFF
304 -DCMAKE_USER_MAKE_RULES_OVERRIDE=${build_rules}"
305
306 # Common configure parameters (invariants)
307 local common_config="${TMPDIR}"/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 ${CMAKE_NO_COLOR} ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> ${common_config}
313 cmakeargs="-C ${common_config} ${cmakeargs}"
314
315 mkdir -p "${CMAKE_BUILD_DIR}"
316 pushd "${CMAKE_BUILD_DIR}" > /dev/null
317 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is $cmakeargs"
318 echo cmake ${cmakeargs} "${CMAKE_USE_DIR}"
319 cmake ${cmakeargs} "${CMAKE_USE_DIR}" || die "cmake failed"
320
321 popd > /dev/null
322 }
323
324 # @FUNCTION: enable_cmake-utils_src_compile
325 # @DESCRIPTION:
326 # General function for compiling with cmake. Default behaviour is to check for
327 # EAPI and respectively to configure as well or just compile.
328 enable_cmake-utils_src_compile() {
329 debug-print-function ${FUNCNAME} "$@"
330
331 has src_configure ${CMAKE_EXPF} || cmake-utils_src_configure
332 cmake-utils_src_make "$@"
333 }
334
335 # @FUNCTION: cmake-utils_src_make
336 # @DESCRIPTION:
337 # Function for building the package. Automatically detects the build type.
338 # All arguments are passed to emake:
339 cmake-utils_src_make() {
340 debug-print-function ${FUNCNAME} "$@"
341
342 _check_build_dir
343 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
344 # first check if Makefile exist otherwise die
345 [[ -e Makefile ]] || die "Makefile not found. Error during configure stage."
346 if [[ -n ${CMAKE_VERBOSE} ]]; then
347 emake VERBOSE=1 "$@" || die "Make failed!"
348 else
349 emake "$@" || die "Make failed!"
350 fi
351 popd &> /dev/null
352 }
353
354 # @FUNCTION: enable_cmake-utils_src_install
355 # @DESCRIPTION:
356 # Function for installing the package. Automatically detects the build type.
357 enable_cmake-utils_src_install() {
358 debug-print-function ${FUNCNAME} "$@"
359
360 _check_build_dir
361 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
362 emake install DESTDIR="${D}" || die "Make install failed"
363 popd &> /dev/null
364
365 # Manual document installation
366 [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; }
367 [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; }
368 }
369
370 # @FUNCTION: enable_cmake-utils_src_test
371 # @DESCRIPTION:
372 # Function for testing the package. Automatically detects the build type.
373 enable_cmake-utils_src_test() {
374 debug-print-function ${FUNCNAME} "$@"
375
376 _check_build_dir
377 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
378 # Standard implementation of src_test
379 if emake -j1 check -n &> /dev/null; then
380 einfo ">>> Test phase [check]: ${CATEGORY}/${PF}"
381 if ! emake -j1 check; then
382 die "Make check failed. See above for details."
383 fi
384 elif emake -j1 test -n &> /dev/null; then
385 einfo ">>> Test phase [test]: ${CATEGORY}/${PF}"
386 if ! emake -j1 test; then
387 die "Make test failed. See above for details."
388 fi
389 else
390 einfo ">>> Test phase [none]: ${CATEGORY}/${PF}"
391 fi
392 popd &> /dev/null
393 }
394
395 ## Wrappers for calls bellow this line
396 # @FUNCTION: cmake-utils_src_configure
397 # @DESCRIPTION:
398 # Wrapper for detection if we want to run enable_ prefixed function with same name
399 # unconditionaly or only when some useflag is enabled.
400 cmake-utils_src_configure() {
401 _inherit_optionaly "src_configure"
402 }
403
404 # @FUNCTION: cmake-utils_src_compile
405 # @DESCRIPTION:
406 # Wrapper for detection if we want to run enable_ prefixed function with same name
407 # unconditionaly or only when some useflag is enabled.
408 cmake-utils_src_compile() {
409 _inherit_optionaly "src_compile"
410 }
411
412 # @FUNCTION: cmake-utils_src_install
413 # @DESCRIPTION:
414 # Wrapper for detection if we want to run enable_ prefixed function with same name
415 # unconditionaly or only when some useflag is enabled.
416 cmake-utils_src_install() {
417 _inherit_optionaly "src_install"
418 }
419
420 # @FUNCTION: cmake-utils_src_test
421 # @DESCRIPTION:
422 # Wrapper for detection if we want to run enable_ prefixed function with same name
423 # unconditionaly or only when some useflag is enabled.
424 cmake-utils_src_test() {
425 _inherit_optionaly "src_test"
426 }
427
428
429 _execute_optionaly() {
430 local phase="$1"
431 if [[ ${WANT_CMAKE} = always ]]; then
432 enable_cmake-utils_${phase}
433 else
434 use ${WANT_CMAKE} && enable_cmake-utils_${phase}
435 fi
436 }

  ViewVC Help
Powered by ViewVC 1.1.20