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

Diff of /eclass/cmake-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.1 Revision 1.29
1# Copyright 1999-2007 Gentoo Foundation 1# Copyright 1999-2009 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.1 2007/11/04 13:17:35 philantrop Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.29 2009/06/17 22:39:01 scarabeus Exp $
4 4
5# @ECLASS: cmake-utils.eclass 5# @ECLASS: cmake-utils.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# kde@gentoo.org 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
8# @BLURB: common ebuild functions for cmake-based packages 15# @BLURB: common ebuild functions for cmake-based packages
9# @DESCRIPTION: 16# @DESCRIPTION:
10# The cmake-utils eclass contains functions that make creating ebuilds for 17# The cmake-utils eclass contains functions that make creating ebuilds for
11# cmake-based packages much easier. 18# cmake-based packages much easier.
12# Its main features are support of out-of-source builds as well as in-source 19# Its main features are support of out-of-source builds as well as in-source
13# builds and an implementation of the well-known use_enable and use_with 20# builds and an implementation of the well-known use_enable and use_with
14# functions for CMake. 21# functions for CMake.
15 22
16# Original author: Zephyrus (zephyrus@mirach.it)
17
18inherit toolchain-funcs multilib 23inherit toolchain-funcs multilib flag-o-matic base
19 24
25EXPF="src_compile src_test src_install"
26case ${EAPI:-0} in
27 2) EXPF="${EXPF} src_configure" ;;
28 1|0) ;;
29 *) die "Unknown EAPI, Bug eclass maintainers." ;;
30esac
31EXPORT_FUNCTIONS ${EXPF}
32
20DESCRIPTION="Based on the ${ECLASS} eclass" 33: ${DESCRIPTION:="Based on the ${ECLASS} eclass"}
21 34
22DEPEND="dev-util/cmake" 35if [[ ${PN} != cmake ]]; then
36 CMAKEDEPEND=">=dev-util/cmake-2.6.2-r1"
37fi
23 38
24EXPORT_FUNCTIONS src_compile src_test src_install 39DEPEND="${CMAKEDEPEND}
40 userland_GNU? ( >=sys-apps/findutils-4.4.0 )
41"
25 42
26# Internal function use by cmake-utils_use_with and cmake-utils_use_enable 43# Internal functions used by cmake-utils_use_*
27_use_me_now() { 44_use_me_now() {
28 debug-print-function $FUNCNAME $* 45 debug-print-function ${FUNCNAME} "$@"
46
47 local uper capitalised x
29 [[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]" 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
30 echo "-D$1_${3:-$2}=$(use $2 && echo ON || echo OFF)" 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
31} 60}
61_use_me_now_inverted() {
62 debug-print-function ${FUNCNAME} "$@"
32 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}
33# @FUNCTION: cmake-utils_use_with 146# @FUNCTION: cmake-utils_use_with
34# @USAGE: <USE flag> [flag name] 147# @USAGE: <USE flag> [flag name]
35# @DESCRIPTION: 148# @DESCRIPTION:
36# Based on use_with. See ebuild.sh 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.
37cmake-utils_use_with() { _use_me_now WITH "$@" ; } 153cmake-utils_use_with() { _use_me_now WITH_ "$@" ; }
38 154
39# @FUNCTION: cmake-utils_use_enable 155# @FUNCTION: cmake-utils_use_enable
40# @USAGE: <USE flag> [flag name] 156# @USAGE: <USE flag> [flag name]
41# @DESCRIPTION: 157# @DESCRIPTION:
42# Based on use_enable. See ebuild.sh 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.
43cmake-utils_use_enable() { _use_me_now ENABLE "$@" ; } 162cmake-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.
171cmake-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.
180cmake-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.
189cmake-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.
198cmake-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.
207cmake-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.
212cmake-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.
221cmake-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 '
237MESSAGE(STATUS "<<< Gentoo configuration >>>
238Build type: ${CMAKE_BUILD_TYPE}
239Install 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.
246cmake-utils_src_configure() {
247 debug-print-function ${FUNCNAME} "$@"
248
249 _check_build_dir init
250
251 # check if CMakeLists.txt exist and if no then die
252 if [[ ! -e "${CMAKE_USE_DIR}"/CMakeLists.txt ]] ; then
253 eerror "I was unable to locate CMakeLists.txt under:"
254 eerror "\"${CMAKE_USE_DIR}/CMakeLists.txt\""
255 eerror "You should consider not inheriting the cmake eclass."
256 die "FATAL: Unable to find CMakeLists.txt"
257 fi
258
259 # Remove dangerous things.
260 _modify-cmakelists
261
262 # @SEE CMAKE_BUILD_TYPE
263 if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then
264 # Handle release builds
265 if ! has debug ${IUSE//+} || ! use debug; then
266 append-cppflags -DNDEBUG
267 fi
268 fi
269
270 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
271 local build_rules="${TMPDIR}"/gentoo_rules.cmake
272cat > ${build_rules} << _EOF_
273SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
274SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
275SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
276SET (CMAKE_CXX_COMPILE_OBJECT "<CMAKE_CXX_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C++ compile command" FORCE)
277_EOF_
278
279 # Common configure parameters (overridable)
280 # NOTE CMAKE_BUILD_TYPE can be only overriden via CMAKE_BUILD_TYPE eclass variable
281 # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect.
282 local cmakeargs="
283 -DCMAKE_INSTALL_PREFIX=${PREFIX:-/usr}
284 ${mycmakeargs}
285 -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
286 -DCMAKE_INSTALL_DO_STRIP=OFF
287 -DCMAKE_USER_MAKE_RULES_OVERRIDE=${build_rules}"
288
289 # Common configure parameters (invariants)
290 local common_config="${TMPDIR}"/gentoo_common_config.cmake
291 local libdir=$(get_libdir)
292cat > ${common_config} << _EOF_
293SET (LIB_SUFFIX ${libdir/lib} CACHE STRING "library path suffix" FORCE)
294_EOF_
295 [[ -n ${CMAKE_NO_COLOR} ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> ${common_config}
296 cmakeargs="-C ${common_config} ${cmakeargs}"
297
298 mkdir -p "${CMAKE_BUILD_DIR}"
299 pushd "${CMAKE_BUILD_DIR}" > /dev/null
300 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: mycmakeargs is $cmakeargs"
301 cmake ${cmakeargs} "${CMAKE_USE_DIR}" || die "cmake failed"
302
303 popd > /dev/null
304}
44 305
45# @FUNCTION: cmake-utils_src_compile 306# @FUNCTION: cmake-utils_src_compile
46# @DESCRIPTION: 307# @DESCRIPTION:
47# General function for compiling with cmake. Default behaviour is to start an 308# General function for compiling with cmake. Default behaviour is to check for
48# out-of-source build 309# EAPI and respectively to configure as well or just compile.
49cmake-utils_src_compile() { 310cmake-utils_src_compile() {
50 debug-print-function $FUNCNAME $* 311 debug-print-function ${FUNCNAME} "$@"
51 312
52 cmake-utils_src_configureout 313 has src_configure ${EXPF} || cmake-utils_src_configure
53 cmake-utils_src_make 314 cmake-utils_src_make "$@"
54} 315}
55 316
56# @FUNCTION: cmake-utils_src_configurein 317# @FUNCTION: cmake-utils_src_configurein
57# @DESCRIPTION: 318# @DESCRIPTION:
58# Function for software that requires configure and building in the source 319# Deprecated
59# directory.
60cmake-utils_src_configurein() { 320cmake-utils_src_configurein() {
61 debug-print-function $FUNCNAME $* 321 ewarn "QA notice: using deprecated ${FUNCNAME} call, set CMAKE_IN_SOURCE_BUILD=1 instead."
62 322 cmake-utils_src_configure
63 local cmakeargs="${mycmakeargs} $(_common_configure_code)"
64
65 debug-print "$LINENO $ECLASS $FUNCNAME: mycmakeargs is $cmakeargs"
66 cmake ${cmakeargs} . || die "Cmake failed"
67} 323}
68 324
69# @FUNCTION: cmake-utils_src_configureout 325# @FUNCTION: cmake-utils_src_configureout
70# @DESCRIPTION: 326# @DESCRIPTION:
71# Function for software that requires configure and building outside the source 327# Deprecated
72# tree - default.
73cmake-utils_src_configureout() { 328cmake-utils_src_configureout() {
74 debug-print-function $FUNCNAME $* 329 ewarn "QA notice: using deprecated ${FUNCNAME} call, out of source build is enabled by default."
75 330 cmake-utils_src_configure
76 local cmakeargs="${mycmakeargs} $(_common_configure_code)"
77 mkdir "${WORKDIR}"/${PN}_build
78 cd "${WORKDIR}"/${PN}_build
79
80 debug-print "$LINENO $ECLASS $FUNCNAME: mycmakeargs is $cmakeargs"
81 cmake ${cmakeargs} "${S}" || die "Cmake failed"
82}
83
84# Internal use only. Common configuration options for all types of builds.
85_common_configure_code() {
86 local tmp_libdir=$(get_libdir)
87 if has debug ${IUSE} && use debug; then
88 echo -DCMAKE_BUILD_TYPE=debug
89 fi
90 echo -DCMAKE_C_COMPILER=$(type -P $(tc-getCC))
91 echo -DCMAKE_CXX_COMPILER=$(type -P $(tc-getCXX))
92 echo -DCMAKE_INSTALL_PREFIX=${PREFIX:-/usr}
93 echo -DLIB_SUFFIX=${tmp_libdir/lib}
94 [[ -n ${CMAKE_NO_COLOR} ]] && echo -DCMAKE_COLOR_MAKEFILE=OFF
95} 331}
96 332
97# @FUNCTION: cmake-utils_src_make 333# @FUNCTION: cmake-utils_src_make
98# @DESCRIPTION: 334# @DESCRIPTION:
99# Function for building the package. Automatically detects the build type. 335# Function for building the package. Automatically detects the build type.
336# All arguments are passed to emake:
100cmake-utils_src_make() { 337cmake-utils_src_make() {
101 debug-print-function $FUNCNAME $* 338 debug-print-function ${FUNCNAME} "$@"
102 339
103 # At this point we can automatically check if it's an out-of-source or an 340 _check_build_dir
104 # in-source build 341 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
105 if [[ -d ${WORKDIR}/${PN}_build ]]; then 342 # first check if Makefile exist otherwise die
106 cd "${WORKDIR}"/${PN}_build; 343 [[ -e Makefile ]] || die "Makefile not found. Error during configure stage."
107 fi
108 if ! [[ -z ${CMAKE_COMPILER_VERBOSE} ]]; then 344 if [[ -n ${CMAKE_VERBOSE} ]]; then
109 emake VERBOSE=1 || die "Make failed!"; 345 emake VERBOSE=1 "$@" || die "Make failed!"
110 else 346 else
111 emake || die "Make failed!"; 347 emake "$@" || die "Make failed!"
112 fi 348 fi
349 popd &> /dev/null
113} 350}
114 351
115# @FUNCTION: cmake-utils_src_install 352# @FUNCTION: cmake-utils_src_install
116# @DESCRIPTION: 353# @DESCRIPTION:
117# Function for installing the package. Automatically detects the build type. 354# Function for installing the package. Automatically detects the build type.
118cmake-utils_src_install() { 355cmake-utils_src_install() {
119 debug-print-function $FUNCNAME $* 356 debug-print-function ${FUNCNAME} "$@"
120 357
121 # At this point we can automatically check if it's an out-of-source or an 358 _check_build_dir
122 # in-source build 359 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
123 if [[ -d ${WORKDIR}/${PN}_build ]]; then
124 cd "${WORKDIR}"/${PN}_build;
125 fi
126 emake install DESTDIR="${D}" || die "Make install failed" 360 emake install DESTDIR="${D}" || die "Make install failed"
361 popd &> /dev/null
362
363 # Manual document installation
364 [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; }
365 [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; }
127} 366}
128 367
129# @FUNCTION: cmake-utils_src_test 368# @FUNCTION: cmake-utils_src_test
130# @DESCRIPTION: 369# @DESCRIPTION:
131# Function for testing the package. Automatically detects the build type. 370# Function for testing the package. Automatically detects the build type.
132cmake-utils_src_test() { 371cmake-utils_src_test() {
133 debug-print-function $FUNCNAME $* 372 debug-print-function ${FUNCNAME} "$@"
134 373
135 # At this point we can automatically check if it's an out-of-source or an 374 _check_build_dir
136 # in-source build 375 pushd "${CMAKE_BUILD_DIR}" &> /dev/null
137 if [[ -d ${WORKDIR}/${PN}_build ]]; then
138 cd "${WORKDIR}"/${PN}_build
139 fi
140 # Standard implementation of src_test 376 # Standard implementation of src_test
141 if emake -j1 check -n &> /dev/null; then 377 if emake -j1 check -n &> /dev/null; then
142 einfo ">>> Test phase [check]: ${CATEGORY}/${PF}" 378 einfo ">>> Test phase [check]: ${CATEGORY}/${PF}"
143 if ! emake -j1 check; then 379 if ! emake -j1 check; then
144 die "Make check failed. See above for details." 380 die "Make check failed. See above for details."
149 die "Make test failed. See above for details." 385 die "Make test failed. See above for details."
150 fi 386 fi
151 else 387 else
152 einfo ">>> Test phase [none]: ${CATEGORY}/${PF}" 388 einfo ">>> Test phase [none]: ${CATEGORY}/${PF}"
153 fi 389 fi
390 popd &> /dev/null
154} 391}

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.29

  ViewVC Help
Powered by ViewVC 1.1.20