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

Contents of /eclass/cmake-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.27 - (hide annotations) (download)
Wed May 27 14:34:33 2009 UTC (5 years, 1 month ago) by scarabeus
Branch: MAIN
Changes since 1.26: +7 -2 lines
Add comment to CMAKE_BUILD_DIR variable. Describing what for it is.

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.27 # $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.26 2009/05/08 10:54:02 scarabeus Exp $
4 philantrop 1.1
5     # @ECLASS: cmake-utils.eclass
6     # @MAINTAINER:
7     # kde@gentoo.org
8 scarabeus 1.23 #
9     # @CODE
10 scarabeus 1.17 # Tomáš Chvátal <scarabeus@gentoo.org>
11     # Maciej Mrozowski <reavertm@poczta.fm>
12     # (undisclosed contributors)
13     # Original author: Zephyrus (zephyrus@mirach.it)
14 scarabeus 1.23 # @CODE
15 philantrop 1.1 # @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 scarabeus 1.17 inherit toolchain-funcs multilib flag-o-matic base
24 philantrop 1.1
25 scarabeus 1.17 EXPF="src_compile src_test src_install"
26     case ${EAPI:-0} in
27 scarabeus 1.26 2) EXPF="${EXPF} src_configure" ;;
28 scarabeus 1.17 1|0) ;;
29     *) die "Unknown EAPI, Bug eclass maintainers." ;;
30 jmbsvicetto 1.10 esac
31 scarabeus 1.17 EXPORT_FUNCTIONS ${EXPF}
32 jmbsvicetto 1.10
33 scarabeus 1.17 : ${DESCRIPTION:="Based on the ${ECLASS} eclass"}
34 philantrop 1.1
35 scarabeus 1.23 if [[ ${PN} != cmake ]]; then
36     CMAKEDEPEND=">=dev-util/cmake-2.6.2-r1"
37     fi
38    
39     DEPEND="${CMAKEDEPEND}
40 scarabeus 1.22 userland_GNU? ( >=sys-apps/findutils-4.4.0 )
41     "
42 scarabeus 1.17
43     # Internal functions used by cmake-utils_use_*
44 philantrop 1.1 _use_me_now() {
45 scarabeus 1.17 debug-print-function ${FUNCNAME} "$@"
46 scarabeus 1.23
47     local uper capitalised x
48 philantrop 1.1 [[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]"
49 scarabeus 1.23 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 philantrop 1.1 }
61 scarabeus 1.17 _use_me_now_inverted() {
62     debug-print-function ${FUNCNAME} "$@"
63 scarabeus 1.23
64     local uper capitalised x
65 scarabeus 1.17 [[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]"
66 scarabeus 1.23 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 scarabeus 1.17 }
78    
79     # @ECLASS-VARIABLE: DOCS
80     # @DESCRIPTION:
81     # Documents passed to dodoc command.
82 philantrop 1.1
83 scarabeus 1.17 # @ECLASS-VARIABLE: HTML_DOCS
84 zlin 1.5 # @DESCRIPTION:
85 scarabeus 1.17 # Documents passed to dohtml command.
86 zlin 1.5
87 scarabeus 1.17 # @ECLASS-VARIABLE: PREFIX
88 scarabeus 1.23 # @DESCRIPTION:
89 scarabeus 1.17 # 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 scarabeus 1.26 # @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 scarabeus 1.27 # @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 scarabeus 1.17 if [[ -n "${CMAKE_IN_SOURCE_BUILD}" ]]; then
133 scarabeus 1.26 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}"
134 scarabeus 1.17 else
135 scarabeus 1.26 CMAKE_BUILD_DIR="${CMAKE_USE_DIR}_build"
136 scarabeus 1.17 fi
137     echo ">>> Working in BUILD_DIR: \"$CMAKE_BUILD_DIR\""
138     }
139 philantrop 1.1 # @FUNCTION: cmake-utils_use_with
140     # @USAGE: <USE flag> [flag name]
141     # @DESCRIPTION:
142 philantrop 1.3 # Based on use_with. See ebuild(5).
143 betelgeuse 1.4 #
144 philantrop 1.3 # `cmake-utils_use_with foo FOO` echoes -DWITH_FOO=ON if foo is enabled
145     # and -DWITH_FOO=OFF if it is disabled.
146 scarabeus 1.20 cmake-utils_use_with() { _use_me_now WITH_ "$@" ; }
147 philantrop 1.1
148     # @FUNCTION: cmake-utils_use_enable
149     # @USAGE: <USE flag> [flag name]
150     # @DESCRIPTION:
151 philantrop 1.3 # Based on use_enable. See ebuild(5).
152 betelgeuse 1.4 #
153 philantrop 1.3 # `cmake-utils_use_enable foo FOO` echoes -DENABLE_FOO=ON if foo is enabled
154     # and -DENABLE_FOO=OFF if it is disabled.
155 scarabeus 1.20 cmake-utils_use_enable() { _use_me_now ENABLE_ "$@" ; }
156 philantrop 1.1
157 scarabeus 1.17 # @FUNCTION: cmake-utils_use_disable
158     # @USAGE: <USE flag> [flag name]
159     # @DESCRIPTION:
160     # Based on inversion of use_enable. See ebuild(5).
161     #
162     # `cmake-utils_use_enable foo FOO` echoes -DDISABLE_FOO=OFF if foo is enabled
163     # and -DDISABLE_FOO=ON if it is disabled.
164 scarabeus 1.20 cmake-utils_use_disable() { _use_me_now_inverted DISABLE_ "$@" ; }
165 scarabeus 1.17
166     # @FUNCTION: cmake-utils_use_no
167     # @USAGE: <USE flag> [flag name]
168     # @DESCRIPTION:
169     # Based on use_disable. See ebuild(5).
170     #
171     # `cmake-utils_use_no foo FOO` echoes -DNO_FOO=OFF if foo is enabled
172     # and -DNO_FOO=ON if it is disabled.
173 scarabeus 1.20 cmake-utils_use_no() { _use_me_now_inverted NO_ "$@" ; }
174 scarabeus 1.17
175 philantrop 1.2 # @FUNCTION: cmake-utils_use_want
176     # @USAGE: <USE flag> [flag name]
177     # @DESCRIPTION:
178 philantrop 1.3 # Based on use_enable. See ebuild(5).
179 betelgeuse 1.4 #
180 philantrop 1.3 # `cmake-utils_use_want foo FOO` echoes -DWANT_FOO=ON if foo is enabled
181     # and -DWANT_FOO=OFF if it is disabled.
182 scarabeus 1.20 cmake-utils_use_want() { _use_me_now WANT_ "$@" ; }
183 philantrop 1.2
184 scarabeus 1.17 # @FUNCTION: cmake-utils_use_build
185     # @USAGE: <USE flag> [flag name]
186     # @DESCRIPTION:
187     # Based on use_enable. See ebuild(5).
188     #
189     # `cmake-utils_use_build foo FOO` echoes -DBUILD_FOO=ON if foo is enabled
190     # and -DBUILD_FOO=OFF if it is disabled.
191 scarabeus 1.20 cmake-utils_use_build() { _use_me_now BUILD_ "$@" ; }
192 scarabeus 1.17
193     # @FUNCTION: cmake-utils_use_has
194     # @USAGE: <USE flag> [flag name]
195     # @DESCRIPTION:
196     # Based on use_enable. See ebuild(5).
197     #
198     # `cmake-utils_use_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled
199     # and -DHAVE_FOO=OFF if it is disabled.
200 scarabeus 1.20 cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; }
201 scarabeus 1.17
202 philantrop 1.3 # @FUNCTION: cmake-utils_has
203 scarabeus 1.17 # @DESCRIPTION:
204     # Deprecated, use cmake-utils_use_has, kept now for backcompat.
205 scarabeus 1.20 cmake-utils_has() { ewarn "QA notice: using deprecated ${FUNCNAME} call, use cmake-utils_use_has instead." ; _use_me_now HAVE_ "$@" ; }
206 scarabeus 1.17
207     # @FUNCTION: cmake-utils_use
208 philantrop 1.3 # @USAGE: <USE flag> [flag name]
209     # @DESCRIPTION:
210     # Based on use_enable. See ebuild(5).
211 betelgeuse 1.4 #
212 scarabeus 1.17 # `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled
213     # and -DFOO=OFF if it is disabled.
214     cmake-utils_use() { _use_me_now "" "$@" ; }
215    
216     # Internal function for modifying hardcoded definitions.
217     # Removes dangerous definitionts that override Gentoo settings.
218     _modify-cmakelists() {
219     debug-print-function ${FUNCNAME} "$@"
220    
221     # Comment out all set (<some_should_be_user_defined_variable> value)
222     # TODO Add QA checker - inform when variable being checked for below is set in CMakeLists.txt
223 scarabeus 1.26 find "${CMAKE_USE_DIR}" -name CMakeLists.txt \
224 scarabeus 1.17 -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_BUILD_TYPE.*)/{s/^/#IGNORE /g}' {} + \
225     -exec sed -i -e '/^[[:space:]]*[sS][eE][tT][[:space:]]*([[:space:]]*CMAKE_INSTALL_PREFIX.*)/{s/^/#IGNORE /g}' {} + \
226     || die "${LINENO}: failed to disable hardcoded settings"
227    
228     # NOTE Append some useful summary here
229     echo '
230     MESSAGE(STATUS "<<< Gentoo configuration >>>
231     Build type: ${CMAKE_BUILD_TYPE}
232     Install path: ${CMAKE_INSTALL_PREFIX}\n")' >> CMakeLists.txt
233     }
234 philantrop 1.3
235 jmbsvicetto 1.9 # @FUNCTION: cmake-utils_src_configure
236 philantrop 1.1 # @DESCRIPTION:
237 jmbsvicetto 1.9 # General function for configuring with cmake. Default behaviour is to start an
238     # out-of-source build.
239     cmake-utils_src_configure() {
240 scarabeus 1.17 debug-print-function ${FUNCNAME} "$@"
241 philantrop 1.1
242 scarabeus 1.26 _check_build_dir
243    
244 scarabeus 1.24 # check if CMakeLists.txt exist and if no then die
245 scarabeus 1.26 if [[ ! -e "${CMAKE_USE_DIR}"/CMakeLists.txt ]] ; then
246 scarabeus 1.24 eerror "I was unable to locate CMakeLists.txt under:"
247 scarabeus 1.26 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\""
248 scarabeus 1.24 eerror "You should consider not inheriting the cmake eclass."
249     die "FATAL: Unable to find CMakeLists.txt"
250     fi
251    
252 scarabeus 1.17 # Remove dangerous things.
253     _modify-cmakelists
254    
255     # @SEE CMAKE_BUILD_TYPE
256     if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then
257     # Handle release builds
258     if ! has debug ${IUSE//+} || ! use debug; then
259     append-cppflags -DNDEBUG
260     fi
261 philantrop 1.2 fi
262 scarabeus 1.17
263     # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
264     local build_rules="${TMPDIR}"/gentoo_rules.cmake
265     cat > ${build_rules} << _EOF_
266     SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
267     SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
268     SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
269     SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE)
270     _EOF_
271    
272     # Common configure parameters (overridable)
273     # NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable
274     # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect.
275     local cmakeargs="
276     -DCMAKE_INSTALL_PREFIX=${PREFIX:-/usr}
277     ${mycmakeargs}
278     -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
279     -DCMAKE_INSTALL_DO_STRIP=OFF
280     -DCMAKE_USER_MAKE_RULES_OVERRIDE=${build_rules}"
281    
282     # Common configure parameters (invariants)
283     local common_config="${TMPDIR}"/gentoo_common_config.cmake
284     local libdir=$(get_libdir)
285     cat > ${common_config} << _EOF_
286     SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
287     _EOF_
288     [[ -n ${CMAKE_NO_COLOR} ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> ${common_config}
289     cmakeargs="-C ${common_config} ${cmakeargs}"
290    
291     mkdir -p "${CMAKE_BUILD_DIR}"
292     pushd "${CMAKE_BUILD_DIR}" > /dev/null
293     debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is $cmakeargs"
294 scarabeus 1.26 cmake ${cmakeargs} "${CMAKE_USE_DIR}" || die "cmake failed"
295 scarabeus 1.17
296     popd > /dev/null
297 jmbsvicetto 1.9 }
298    
299     # @FUNCTION: cmake-utils_src_compile
300     # @DESCRIPTION:
301     # General function for compiling with cmake. Default behaviour is to check for
302 scarabeus 1.17 # EAPI and respectively to configure as well or just compile.
303 jmbsvicetto 1.9 cmake-utils_src_compile() {
304 scarabeus 1.17 debug-print-function ${FUNCNAME} "$@"
305 jmbsvicetto 1.9
306 scarabeus 1.17 has src_configure ${EXPF} || cmake-utils_src_configure
307 philantrop 1.3 cmake-utils_src_make "$@"
308 philantrop 1.1 }
309    
310     # @FUNCTION: cmake-utils_src_configurein
311     # @DESCRIPTION:
312 scarabeus 1.17 # Deprecated
313 philantrop 1.1 cmake-utils_src_configurein() {
314 scarabeus 1.18 ewarn "QA notice: using deprecated ${FUNCNAME} call, set CMAKE_IN_SOURCE_BUILD=1 instead."
315 scarabeus 1.17 cmake-utils_src_configure
316 philantrop 1.1 }
317    
318     # @FUNCTION: cmake-utils_src_configureout
319     # @DESCRIPTION:
320 scarabeus 1.17 # Deprecated
321 philantrop 1.1 cmake-utils_src_configureout() {
322 scarabeus 1.18 ewarn "QA notice: using deprecated ${FUNCNAME} call, out of source build is enabled by default."
323 scarabeus 1.17 cmake-utils_src_configure
324 philantrop 1.1 }
325    
326     # @FUNCTION: cmake-utils_src_make
327     # @DESCRIPTION:
328     # Function for building the package. Automatically detects the build type.
329 philantrop 1.3 # All arguments are passed to emake:
330 philantrop 1.1 cmake-utils_src_make() {
331 scarabeus 1.17 debug-print-function ${FUNCNAME} "$@"
332 philantrop 1.1
333 scarabeus 1.17 _check_build_dir
334     pushd "${CMAKE_BUILD_DIR}" > /dev/null
335 scarabeus 1.25 # first check if Makefile exist otherwise die
336     [[ -e Makefile ]] || die "Makefile not found. Error during configure stage."
337 scarabeus 1.17 if [[ -n ${CMAKE_VERBOSE} ]]; then
338 philantrop 1.3 emake VERBOSE=1 "$@" || die "Make failed!"
339 philantrop 1.1 else
340 philantrop 1.3 emake "$@" || die "Make failed!"
341 philantrop 1.2 fi
342 scarabeus 1.17 popd > /dev/null
343 philantrop 1.1 }
344    
345     # @FUNCTION: cmake-utils_src_install
346     # @DESCRIPTION:
347     # Function for installing the package. Automatically detects the build type.
348     cmake-utils_src_install() {
349 scarabeus 1.17 debug-print-function ${FUNCNAME} "$@"
350 philantrop 1.1
351 scarabeus 1.17 _check_build_dir
352     pushd "${CMAKE_BUILD_DIR}" > /dev/null
353 philantrop 1.1 emake install DESTDIR="${D}" || die "Make install failed"
354 scarabeus 1.17 popd > /dev/null
355 zlin 1.5
356     # Manual document installation
357 scarabeus 1.17 [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; }
358     [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; }
359 philantrop 1.1 }
360    
361     # @FUNCTION: cmake-utils_src_test
362     # @DESCRIPTION:
363     # Function for testing the package. Automatically detects the build type.
364     cmake-utils_src_test() {
365 scarabeus 1.17 debug-print-function ${FUNCNAME} "$@"
366 philantrop 1.1
367 scarabeus 1.17 _check_build_dir
368     pushd "${CMAKE_BUILD_DIR}" > /dev/null
369 philantrop 1.1 # Standard implementation of src_test
370     if emake -j1 check -n &> /dev/null; then
371     einfo ">>> Test phase [check]: ${CATEGORY}/${PF}"
372     if ! emake -j1 check; then
373     die "Make check failed. See above for details."
374     fi
375     elif emake -j1 test -n &> /dev/null; then
376     einfo ">>> Test phase [test]: ${CATEGORY}/${PF}"
377     if ! emake -j1 test; then
378     die "Make test failed. See above for details."
379     fi
380     else
381     einfo ">>> Test phase [none]: ${CATEGORY}/${PF}"
382     fi
383 scarabeus 1.17 popd > /dev/null
384 philantrop 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20