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

Contents of /eclass/cmake-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.22 - (hide annotations) (download)
Thu Mar 19 09:12:41 2009 UTC (5 years, 4 months ago) by scarabeus
Branch: MAIN
Changes since 1.21: +5 -2 lines
Depend on correct findutils. Per bug #262965. Thanks Loki_val for correct approach.

1 fauli 1.19 # Copyright 1999-2009 Gentoo Foundation
2 philantrop 1.1 # Distributed under the terms of the GNU General Public License v2
3 scarabeus 1.22 # $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.21 2009/03/15 16:54:32 scarabeus Exp $
4 philantrop 1.1
5     # @ECLASS: cmake-utils.eclass
6     # @MAINTAINER:
7     # kde@gentoo.org
8 scarabeus 1.17 # @AUTHORS:
9     # Tomáš Chvátal <scarabeus@gentoo.org>
10     # Maciej Mrozowski <reavertm@poczta.fm>
11     # (undisclosed contributors)
12     # Original author: Zephyrus (zephyrus@mirach.it)
13 philantrop 1.1 # @BLURB: common ebuild functions for cmake-based packages
14     # @DESCRIPTION:
15     # The cmake-utils eclass contains functions that make creating ebuilds for
16     # cmake-based packages much easier.
17     # Its main features are support of out-of-source builds as well as in-source
18     # builds and an implementation of the well-known use_enable and use_with
19     # functions for CMake.
20    
21 scarabeus 1.17 inherit toolchain-funcs multilib flag-o-matic base
22 philantrop 1.1
23 scarabeus 1.17 EXPF="src_compile src_test src_install"
24     case ${EAPI:-0} in
25     2) EXPF="${EXPF} src_configure"
26 jmbsvicetto 1.10 ;;
27 scarabeus 1.17 1|0) ;;
28     *) die "Unknown EAPI, Bug eclass maintainers." ;;
29 jmbsvicetto 1.10 esac
30 scarabeus 1.17 EXPORT_FUNCTIONS ${EXPF}
31 jmbsvicetto 1.10
32 scarabeus 1.17 : ${DESCRIPTION:="Based on the ${ECLASS} eclass"}
33 philantrop 1.1
34 scarabeus 1.22 DEPEND="
35     >=dev-util/cmake-2.6.2-r1
36     userland_GNU? ( >=sys-apps/findutils-4.4.0 )
37     "
38 scarabeus 1.17
39     # Internal functions used by cmake-utils_use_*
40 philantrop 1.1 _use_me_now() {
41 scarabeus 1.17 debug-print-function ${FUNCNAME} "$@"
42 philantrop 1.1 [[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]"
43 scarabeus 1.20 echo "-D$1${3:-$2}=$(use $2 && echo ON || echo OFF)"
44 philantrop 1.1 }
45 scarabeus 1.17 _use_me_now_inverted() {
46     debug-print-function ${FUNCNAME} "$@"
47     [[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]"
48 scarabeus 1.20 echo "-D$1${3:-$2}=$(use $2 && echo OFF || echo ON)"
49 scarabeus 1.17 }
50    
51     # @ECLASS-VARIABLE: DOCS
52     # @DESCRIPTION:
53     # Documents passed to dodoc command.
54 philantrop 1.1
55 scarabeus 1.17 # @ECLASS-VARIABLE: HTML_DOCS
56 zlin 1.5 # @DESCRIPTION:
57 scarabeus 1.17 # Documents passed to dohtml command.
58 zlin 1.5
59 scarabeus 1.17 # @ECLASS-VARIABLE: PREFIX
60     # @DESCRIPTION
61     # Eclass respects PREFIX variable, though it's not recommended way to set
62     # install/lib/bin prefixes.
63     # Use -DCMAKE_INSTALL_PREFIX=... CMake variable instead.
64    
65     # @ECLASS-VARIABLE: CMAKE_IN_SOURCE_BUILD
66     # @DESCRIPTION:
67     # Set to enable in-source build.
68    
69     # @ECLASS-VARIABLE: CMAKE_NO_COLOR
70     # @DESCRIPTION:
71     # Set to disable cmake output coloring.
72    
73     # @ECLASS-VARIABLE: CMAKE_VERBOSE
74     # @DESCRIPTION:
75     # Set to enable verbose messages during compilation.
76    
77     # @ECLASS-VARIABLE: CMAKE_BUILD_TYPE
78     # @DESCRIPTION:
79     # Set to override default CMAKE_BUILD_TYPE. Only useful for packages
80     # known to make use of "if (CMAKE_BUILD_TYPE MATCHES xxx)".
81     # If about to be set - needs to be set before invoking cmake-utils_src_configure.
82     # You usualy do *NOT* want nor need to set it as it pulls CMake default build-type
83     # specific compiler flags overriding make.conf.
84     : ${CMAKE_BUILD_TYPE:=Gentoo}
85    
86     # @FUNCTION: _check_build_dir
87     # @DESCRIPTION:
88     # Determine using IN or OUT source build
89     _check_build_dir() {
90     # in/out source build
91     if [[ -n "${CMAKE_IN_SOURCE_BUILD}" ]]; then
92     CMAKE_BUILD_DIR="${S}"
93     else
94     CMAKE_BUILD_DIR="${WORKDIR}/${PN}_build"
95     fi
96     echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\""
97     }
98 philantrop 1.1 # @FUNCTION: cmake-utils_use_with
99     # @USAGE: <USE flag> [flag name]
100     # @DESCRIPTION:
101 philantrop 1.3 # Based on use_with. See ebuild(5).
102 betelgeuse 1.4 #
103 philantrop 1.3 # `cmake-utils_use_with foo FOO` echoes -DWITH_FOO=ON if foo is enabled
104     # and -DWITH_FOO=OFF if it is disabled.
105 scarabeus 1.20 cmake-utils_use_with() { _use_me_now WITH_ "$@" ; }
106 philantrop 1.1
107     # @FUNCTION: cmake-utils_use_enable
108     # @USAGE: <USE flag> [flag name]
109     # @DESCRIPTION:
110 philantrop 1.3 # Based on use_enable. See ebuild(5).
111 betelgeuse 1.4 #
112 philantrop 1.3 # `cmake-utils_use_enable foo FOO` echoes -DENABLE_FOO=ON if foo is enabled
113     # and -DENABLE_FOO=OFF if it is disabled.
114 scarabeus 1.20 cmake-utils_use_enable() { _use_me_now ENABLE_ "$@" ; }
115 philantrop 1.1
116 scarabeus 1.17 # @FUNCTION: cmake-utils_use_disable
117     # @USAGE: <USE flag> [flag name]
118     # @DESCRIPTION:
119     # Based on inversion of use_enable. See ebuild(5).
120     #
121     # `cmake-utils_use_enable foo FOO` echoes -DDISABLE_FOO=OFF if foo is enabled
122     # and -DDISABLE_FOO=ON if it is disabled.
123 scarabeus 1.20 cmake-utils_use_disable() { _use_me_now_inverted DISABLE_ "$@" ; }
124 scarabeus 1.17
125     # @FUNCTION: cmake-utils_use_no
126     # @USAGE: <USE flag> [flag name]
127     # @DESCRIPTION:
128     # Based on use_disable. See ebuild(5).
129     #
130     # `cmake-utils_use_no foo FOO` echoes -DNO_FOO=OFF if foo is enabled
131     # and -DNO_FOO=ON if it is disabled.
132 scarabeus 1.20 cmake-utils_use_no() { _use_me_now_inverted NO_ "$@" ; }
133 scarabeus 1.17
134 philantrop 1.2 # @FUNCTION: cmake-utils_use_want
135     # @USAGE: <USE flag> [flag name]
136     # @DESCRIPTION:
137 philantrop 1.3 # Based on use_enable. See ebuild(5).
138 betelgeuse 1.4 #
139 philantrop 1.3 # `cmake-utils_use_want foo FOO` echoes -DWANT_FOO=ON if foo is enabled
140     # and -DWANT_FOO=OFF if it is disabled.
141 scarabeus 1.20 cmake-utils_use_want() { _use_me_now WANT_ "$@" ; }
142 philantrop 1.2
143 scarabeus 1.17 # @FUNCTION: cmake-utils_use_build
144     # @USAGE: <USE flag> [flag name]
145     # @DESCRIPTION:
146     # Based on use_enable. See ebuild(5).
147     #
148     # `cmake-utils_use_build foo FOO` echoes -DBUILD_FOO=ON if foo is enabled
149     # and -DBUILD_FOO=OFF if it is disabled.
150 scarabeus 1.20 cmake-utils_use_build() { _use_me_now BUILD_ "$@" ; }
151 scarabeus 1.17
152     # @FUNCTION: cmake-utils_use_has
153     # @USAGE: <USE flag> [flag name]
154     # @DESCRIPTION:
155     # Based on use_enable. See ebuild(5).
156     #
157     # `cmake-utils_use_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled
158     # and -DHAVE_FOO=OFF if it is disabled.
159 scarabeus 1.20 cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; }
160 scarabeus 1.17
161 philantrop 1.3 # @FUNCTION: cmake-utils_has
162 scarabeus 1.17 # @DESCRIPTION:
163     # Deprecated, use cmake-utils_use_has, kept now for backcompat.
164 scarabeus 1.20 cmake-utils_has() { ewarn "QA notice: using deprecated ${FUNCNAME} call, use cmake-utils_use_has instead." ; _use_me_now HAVE_ "$@" ; }
165 scarabeus 1.17
166     # @FUNCTION: cmake-utils_use
167 philantrop 1.3 # @USAGE: <USE flag> [flag name]
168     # @DESCRIPTION:
169     # Based on use_enable. See ebuild(5).
170 betelgeuse 1.4 #
171 scarabeus 1.17 # `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled
172     # and -DFOO=OFF if it is disabled.
173     cmake-utils_use() { _use_me_now "" "$@" ; }
174    
175     # Internal function for modifying hardcoded definitions.
176     # Removes dangerous definitionts that override Gentoo settings.
177     _modify-cmakelists() {
178     debug-print-function ${FUNCNAME} "$@"
179    
180     # Comment out all set (<some_should_be_user_defined_variable> value)
181     # TODO Add QA checker - inform when variable being checked for below is set in CMakeLists.txt
182     find "${S}" -name CMakeLists.txt \
183     -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_BUILD_TYPE.*)/{s/^/#IGNORE /g}' {} + \
184     -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \
185     || die "${LINENO}: failed to disable hardcoded settings"
186    
187     # NOTE Append some useful summary here
188     echo '
189     MESSAGE(STATUS "<<< Gentoo configuration >>>
190     Build type: ${CMAKE_BUILD_TYPE}
191     Install path: ${CMAKE_INSTALL_PREFIX}\n")' >> CMakeLists.txt
192     }
193 philantrop 1.3
194 jmbsvicetto 1.9 # @FUNCTION: cmake-utils_src_configure
195 philantrop 1.1 # @DESCRIPTION:
196 jmbsvicetto 1.9 # General function for configuring with cmake. Default behaviour is to start an
197     # out-of-source build.
198     cmake-utils_src_configure() {
199 scarabeus 1.17 debug-print-function ${FUNCNAME} "$@"
200 philantrop 1.1
201 scarabeus 1.17 # Remove dangerous things.
202     _modify-cmakelists
203    
204     # @SEE CMAKE_BUILD_TYPE
205     if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then
206     # Handle release builds
207     if ! has debug ${IUSE//+} || ! use debug; then
208     append-cppflags -DNDEBUG
209     fi
210 philantrop 1.2 fi
211 scarabeus 1.17
212     # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
213     local build_rules="${TMPDIR}"/gentoo_rules.cmake
214     cat > ${build_rules} << _EOF_
215     SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
216     SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
217     SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
218     SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE)
219     _EOF_
220    
221     # Common configure parameters (overridable)
222     # NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable
223     # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect.
224     local cmakeargs="
225     -DCMAKE_INSTALL_PREFIX=${PREFIX:-/usr}
226     ${mycmakeargs}
227     -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
228     -DCMAKE_INSTALL_DO_STRIP=OFF
229     -DCMAKE_USER_MAKE_RULES_OVERRIDE=${build_rules}"
230    
231     # Common configure parameters (invariants)
232     local common_config="${TMPDIR}"/gentoo_common_config.cmake
233     local libdir=$(get_libdir)
234     cat > ${common_config} << _EOF_
235     SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
236     _EOF_
237     [[ -n ${CMAKE_NO_COLOR} ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> ${common_config}
238     cmakeargs="-C ${common_config} ${cmakeargs}"
239    
240     _check_build_dir
241     mkdir -p "${CMAKE_BUILD_DIR}"
242     pushd "${CMAKE_BUILD_DIR}" > /dev/null
243     debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is $cmakeargs"
244     cmake ${cmakeargs} "${S}" || die "cmake failed"
245    
246     popd > /dev/null
247 jmbsvicetto 1.9 }
248    
249     # @FUNCTION: cmake-utils_src_compile
250     # @DESCRIPTION:
251     # General function for compiling with cmake. Default behaviour is to check for
252 scarabeus 1.17 # EAPI and respectively to configure as well or just compile.
253 jmbsvicetto 1.9 cmake-utils_src_compile() {
254 scarabeus 1.17 debug-print-function ${FUNCNAME} "$@"
255 jmbsvicetto 1.9
256 scarabeus 1.17 has src_configure ${EXPF} || cmake-utils_src_configure
257 philantrop 1.3 cmake-utils_src_make "$@"
258 philantrop 1.1 }
259    
260     # @FUNCTION: cmake-utils_src_configurein
261     # @DESCRIPTION:
262 scarabeus 1.17 # Deprecated
263 philantrop 1.1 cmake-utils_src_configurein() {
264 scarabeus 1.18 ewarn "QA notice: using deprecated ${FUNCNAME} call, set CMAKE_IN_SOURCE_BUILD=1 instead."
265 scarabeus 1.17 cmake-utils_src_configure
266 philantrop 1.1 }
267    
268     # @FUNCTION: cmake-utils_src_configureout
269     # @DESCRIPTION:
270 scarabeus 1.17 # Deprecated
271 philantrop 1.1 cmake-utils_src_configureout() {
272 scarabeus 1.18 ewarn "QA notice: using deprecated ${FUNCNAME} call, out of source build is enabled by default."
273 scarabeus 1.17 cmake-utils_src_configure
274 philantrop 1.1 }
275    
276     # @FUNCTION: cmake-utils_src_make
277     # @DESCRIPTION:
278     # Function for building the package. Automatically detects the build type.
279 philantrop 1.3 # All arguments are passed to emake:
280 philantrop 1.1 cmake-utils_src_make() {
281 scarabeus 1.17 debug-print-function ${FUNCNAME} "$@"
282 philantrop 1.1
283 scarabeus 1.17 _check_build_dir
284     pushd "${CMAKE_BUILD_DIR}" > /dev/null
285     if [[ -n ${CMAKE_VERBOSE} ]]; then
286 philantrop 1.3 emake VERBOSE=1 "$@" || die "Make failed!"
287 philantrop 1.1 else
288 philantrop 1.3 emake "$@" || die "Make failed!"
289 philantrop 1.2 fi
290 scarabeus 1.17 popd > /dev/null
291 philantrop 1.1 }
292    
293     # @FUNCTION: cmake-utils_src_install
294     # @DESCRIPTION:
295     # Function for installing the package. Automatically detects the build type.
296     cmake-utils_src_install() {
297 scarabeus 1.17 debug-print-function ${FUNCNAME} "$@"
298 philantrop 1.1
299 scarabeus 1.17 _check_build_dir
300     pushd "${CMAKE_BUILD_DIR}" > /dev/null
301 philantrop 1.1 emake install DESTDIR="${D}" || die "Make install failed"
302 scarabeus 1.17 popd > /dev/null
303 zlin 1.5
304     # Manual document installation
305 scarabeus 1.17 [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; }
306     [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; }
307 philantrop 1.1 }
308    
309     # @FUNCTION: cmake-utils_src_test
310     # @DESCRIPTION:
311     # Function for testing the package. Automatically detects the build type.
312     cmake-utils_src_test() {
313 scarabeus 1.17 debug-print-function ${FUNCNAME} "$@"
314 philantrop 1.1
315 scarabeus 1.17 _check_build_dir
316     pushd "${CMAKE_BUILD_DIR}" > /dev/null
317 philantrop 1.1 # Standard implementation of src_test
318     if emake -j1 check -n &> /dev/null; then
319     einfo ">>> Test phase [check]: ${CATEGORY}/${PF}"
320     if ! emake -j1 check; then
321     die "Make check failed. See above for details."
322     fi
323     elif emake -j1 test -n &> /dev/null; then
324     einfo ">>> Test phase [test]: ${CATEGORY}/${PF}"
325     if ! emake -j1 test; then
326     die "Make test failed. See above for details."
327     fi
328     else
329     einfo ">>> Test phase [none]: ${CATEGORY}/${PF}"
330     fi
331 scarabeus 1.17 popd > /dev/null
332 philantrop 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20