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

Contents of /eclass/cmake-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.31 - (show annotations) (download)
Fri Oct 16 12:24:09 2009 UTC (5 years, 2 months ago) by ssuominen
Branch: MAIN
Changes since 1.30: +3 -1 lines
export XDG_CONFIG_HOME to temp. directory for sandbox

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

  ViewVC Help
Powered by ViewVC 1.1.20