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

Legend:
Removed from v.1.13  
changed lines
  Added in v.1.18

  ViewVC Help
Powered by ViewVC 1.1.20