/[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.6 Revision 1.22
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.6 2008/02/20 14:33:20 zlin Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/cmake-utils.eclass,v 1.22 2009/03/19 09:12:41 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
23EXPF="src_compile src_test src_install"
24case ${EAPI:-0} in
25 2) EXPF="${EXPF} src_configure"
26 ;;
27 1|0) ;;
28 *) die "Unknown EAPI, Bug eclass maintainers." ;;
29esac
30EXPORT_FUNCTIONS ${EXPF}
31
20DESCRIPTION="Based on the ${ECLASS} eclass" 32: ${DESCRIPTION:="Based on the ${ECLASS} eclass"}
21 33
22DEPEND="dev-util/cmake" 34DEPEND="
35 >=dev-util/cmake-2.6.2-r1
36 userland_GNU? ( >=sys-apps/findutils-4.4.0 )
37"
23 38
24EXPORT_FUNCTIONS src_compile src_test src_install 39# Internal functions used by cmake-utils_use_*
25
26# Internal function use by cmake-utils_use_with and cmake-utils_use_enable
27_use_me_now() { 40_use_me_now() {
28 debug-print-function $FUNCNAME $* 41 debug-print-function ${FUNCNAME} "$@"
29 [[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]" 42 [[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]"
30 echo "-D$1_${3:-$2}=$(use $2 && echo ON || echo OFF)" 43 echo "-D$1${3:-$2}=$(use $2 && echo ON || echo OFF)"
31} 44}
45_use_me_now_inverted() {
46 debug-print-function ${FUNCNAME} "$@"
47 [[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]"
48 echo "-D$1${3:-$2}=$(use $2 && echo OFF || echo ON)"
49}
32 50
33# @VARIABLE: DOCS 51# @ECLASS-VARIABLE: DOCS
52# @DESCRIPTION:
53# Documents passed to dodoc command.
54
55# @ECLASS-VARIABLE: HTML_DOCS
56# @DESCRIPTION:
57# Documents passed to dohtml command.
58
59# @ECLASS-VARIABLE: PREFIX
34# @DESCRIPTION: 60# @DESCRIPTION
35# Documents to dodoc 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.
36 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}
37# @FUNCTION: cmake-utils_use_with 98# @FUNCTION: cmake-utils_use_with
38# @USAGE: <USE flag> [flag name] 99# @USAGE: <USE flag> [flag name]
39# @DESCRIPTION: 100# @DESCRIPTION:
40# Based on use_with. See ebuild(5). 101# Based on use_with. See ebuild(5).
41# 102#
42# `cmake-utils_use_with foo FOO` echoes -DWITH_FOO=ON if foo is enabled 103# `cmake-utils_use_with foo FOO` echoes -DWITH_FOO=ON if foo is enabled
43# and -DWITH_FOO=OFF if it is disabled. 104# and -DWITH_FOO=OFF if it is disabled.
44cmake-utils_use_with() { _use_me_now WITH "$@" ; } 105cmake-utils_use_with() { _use_me_now WITH_ "$@" ; }
45 106
46# @FUNCTION: cmake-utils_use_enable 107# @FUNCTION: cmake-utils_use_enable
47# @USAGE: <USE flag> [flag name] 108# @USAGE: <USE flag> [flag name]
48# @DESCRIPTION: 109# @DESCRIPTION:
49# Based on use_enable. See ebuild(5). 110# Based on use_enable. See ebuild(5).
50# 111#
51# `cmake-utils_use_enable foo FOO` echoes -DENABLE_FOO=ON if foo is enabled 112# `cmake-utils_use_enable foo FOO` echoes -DENABLE_FOO=ON if foo is enabled
52# and -DENABLE_FOO=OFF if it is disabled. 113# and -DENABLE_FOO=OFF if it is disabled.
53cmake-utils_use_enable() { _use_me_now ENABLE "$@" ; } 114cmake-utils_use_enable() { _use_me_now ENABLE_ "$@" ; }
115
116# @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.
123cmake-utils_use_disable() { _use_me_now_inverted DISABLE_ "$@" ; }
124
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.
132cmake-utils_use_no() { _use_me_now_inverted NO_ "$@" ; }
54 133
55# @FUNCTION: cmake-utils_use_want 134# @FUNCTION: cmake-utils_use_want
56# @USAGE: <USE flag> [flag name] 135# @USAGE: <USE flag> [flag name]
57# @DESCRIPTION: 136# @DESCRIPTION:
58# Based on use_enable. See ebuild(5). 137# Based on use_enable. See ebuild(5).
59# 138#
60# `cmake-utils_use_want foo FOO` echoes -DWANT_FOO=ON if foo is enabled 139# `cmake-utils_use_want foo FOO` echoes -DWANT_FOO=ON if foo is enabled
61# and -DWANT_FOO=OFF if it is disabled. 140# and -DWANT_FOO=OFF if it is disabled.
62cmake-utils_use_want() { _use_me_now WANT "$@" ; } 141cmake-utils_use_want() { _use_me_now WANT_ "$@" ; }
142
143# @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.
150cmake-utils_use_build() { _use_me_now BUILD_ "$@" ; }
151
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.
159cmake-utils_use_has() { _use_me_now HAVE_ "$@" ; }
63 160
64# @FUNCTION: cmake-utils_has 161# @FUNCTION: cmake-utils_has
65# @USAGE: <USE flag> [flag name]
66# @DESCRIPTION: 162# @DESCRIPTION:
163# Deprecated, use cmake-utils_use_has, kept now for backcompat.
164cmake-utils_has() { ewarn "QA notice: using deprecated ${FUNCNAME} call, use cmake-utils_use_has instead." ; _use_me_now HAVE_ "$@" ; }
165
166# @FUNCTION: cmake-utils_use
167# @USAGE: <USE flag> [flag name]
168# @DESCRIPTION:
67# Based on use_enable. See ebuild(5). 169# Based on use_enable. See ebuild(5).
68# 170#
69# `cmake-utils_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled 171# `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled
70# and -DHAVE_FOO=OFF if it is disabled. 172# and -DFOO=OFF if it is disabled.
71cmake-utils_has() { _use_me_now HAVE "$@" ; } 173cmake-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 '
189MESSAGE(STATUS "<<< Gentoo configuration >>>
190Build type: ${CMAKE_BUILD_TYPE}
191Install path: ${CMAKE_INSTALL_PREFIX}\n")' >> CMakeLists.txt
192}
193
194# @FUNCTION: cmake-utils_src_configure
195# @DESCRIPTION:
196# General function for configuring with cmake. Default behaviour is to start an
197# out-of-source build.
198cmake-utils_src_configure() {
199 debug-print-function ${FUNCNAME} "$@"
200
201 # 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 fi
211
212 # Prepare Gentoo override rules (set valid compiler, append CPPFLAGS)
213 local build_rules="${TMPDIR}"/gentoo_rules.cmake
214cat > ${build_rules} << _EOF_
215SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE)
216SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE)
217SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE)
218SET (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)
234cat > ${common_config} << _EOF_
235SET (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}
72 248
73# @FUNCTION: cmake-utils_src_compile 249# @FUNCTION: cmake-utils_src_compile
74# @DESCRIPTION: 250# @DESCRIPTION:
75# General function for compiling with cmake. Default behaviour is to start an 251# General function for compiling with cmake. Default behaviour is to check for
76# out-of-source build. All arguments are passed to cmake-utils_src_make. 252# EAPI and respectively to configure as well or just compile.
77cmake-utils_src_compile() { 253cmake-utils_src_compile() {
78 debug-print-function $FUNCNAME $* 254 debug-print-function ${FUNCNAME} "$@"
79 255
80 if [[ -n "${CMAKE_IN_SOURCE_BUILD}" ]]; then 256 has src_configure ${EXPF} || cmake-utils_src_configure
81 cmake-utils_src_configurein
82 else
83 cmake-utils_src_configureout
84 fi
85 cmake-utils_src_make "$@" 257 cmake-utils_src_make "$@"
86} 258}
87 259
88# @FUNCTION: cmake-utils_src_configurein 260# @FUNCTION: cmake-utils_src_configurein
89# @DESCRIPTION: 261# @DESCRIPTION:
90# Function for software that requires configure and building in the source 262# Deprecated
91# directory.
92cmake-utils_src_configurein() { 263cmake-utils_src_configurein() {
93 debug-print-function $FUNCNAME $* 264 ewarn "QA notice: using deprecated ${FUNCNAME} call, set CMAKE_IN_SOURCE_BUILD=1 instead."
94 265 cmake-utils_src_configure
95 local cmakeargs="$(_common_configure_code) ${mycmakeargs}"
96
97 debug-print "$LINENO $ECLASS $FUNCNAME: mycmakeargs is $cmakeargs"
98 cmake ${cmakeargs} . || die "Cmake failed"
99} 266}
100 267
101# @FUNCTION: cmake-utils_src_configureout 268# @FUNCTION: cmake-utils_src_configureout
102# @DESCRIPTION: 269# @DESCRIPTION:
103# Function for software that requires configure and building outside the source 270# Deprecated
104# tree - default.
105cmake-utils_src_configureout() { 271cmake-utils_src_configureout() {
106 debug-print-function $FUNCNAME $* 272 ewarn "QA notice: using deprecated ${FUNCNAME} call, out of source build is enabled by default."
107 273 cmake-utils_src_configure
108 local cmakeargs="$(_common_configure_code) ${mycmakeargs}"
109 mkdir -p "${WORKDIR}"/${PN}_build
110 pushd "${WORKDIR}"/${PN}_build > /dev/null
111
112 debug-print "$LINENO $ECLASS $FUNCNAME: mycmakeargs is $cmakeargs"
113 cmake ${cmakeargs} "${S}" || die "Cmake failed"
114
115 popd > /dev/null
116}
117
118# Internal use only. Common configuration options for all types of builds.
119_common_configure_code() {
120 local tmp_libdir=$(get_libdir)
121 if has debug ${IUSE//+} && use debug; then
122 echo -DCMAKE_BUILD_TYPE=Debug
123 else
124 echo -DCMAKE_BUILD_TYPE=Release
125 fi
126 echo -DCMAKE_C_COMPILER=$(type -P $(tc-getCC))
127 echo -DCMAKE_CXX_COMPILER=$(type -P $(tc-getCXX))
128 echo -DCMAKE_INSTALL_PREFIX=${PREFIX:-/usr}
129 echo -DLIB_SUFFIX=${tmp_libdir/lib}
130 echo -DLIB_INSTALL_DIR=${PREFIX:-/usr}/${tmp_libdir}
131 [[ -n ${CMAKE_NO_COLOR} ]] && echo -DCMAKE_COLOR_MAKEFILE=OFF
132} 274}
133 275
134# @FUNCTION: cmake-utils_src_make 276# @FUNCTION: cmake-utils_src_make
135# @DESCRIPTION: 277# @DESCRIPTION:
136# Function for building the package. Automatically detects the build type. 278# Function for building the package. Automatically detects the build type.
137# All arguments are passed to emake: 279# All arguments are passed to emake:
138# "cmake-utils_src_make -j1" can be used to work around parallel make issues.
139cmake-utils_src_make() { 280cmake-utils_src_make() {
140 debug-print-function $FUNCNAME $* 281 debug-print-function ${FUNCNAME} "$@"
141 282
142 # At this point we can automatically check if it's an out-of-source or an 283 _check_build_dir
143 # in-source build 284 pushd "${CMAKE_BUILD_DIR}" > /dev/null
144 if [[ -d ${WORKDIR}/${PN}_build ]]; then
145 pushd "${WORKDIR}"/${PN}_build > /dev/null
146 fi
147 if ! [[ -z ${CMAKE_COMPILER_VERBOSE} ]]; then 285 if [[ -n ${CMAKE_VERBOSE} ]]; then
148 emake VERBOSE=1 "$@" || die "Make failed!" 286 emake VERBOSE=1 "$@" || die "Make failed!"
149 else 287 else
150 emake "$@" || die "Make failed!" 288 emake "$@" || die "Make failed!"
151 fi 289 fi
152 if [[ -d ${WORKDIR}/${PN}_build ]]; then
153 popd > /dev/null 290 popd > /dev/null
154 fi
155} 291}
156 292
157# @FUNCTION: cmake-utils_src_install 293# @FUNCTION: cmake-utils_src_install
158# @DESCRIPTION: 294# @DESCRIPTION:
159# Function for installing the package. Automatically detects the build type. 295# Function for installing the package. Automatically detects the build type.
160cmake-utils_src_install() { 296cmake-utils_src_install() {
161 debug-print-function $FUNCNAME $* 297 debug-print-function ${FUNCNAME} "$@"
162 298
163 # At this point we can automatically check if it's an out-of-source or an 299 _check_build_dir
164 # in-source build 300 pushd "${CMAKE_BUILD_DIR}" > /dev/null
165 if [[ -d ${WORKDIR}/${PN}_build ]]; then
166 pushd "${WORKDIR}"/${PN}_build > /dev/null
167 fi
168 emake install DESTDIR="${D}" || die "Make install failed" 301 emake install DESTDIR="${D}" || die "Make install failed"
169 if [[ -d ${WORKDIR}/${PN}_build ]]; then
170 popd > /dev/null 302 popd > /dev/null
171 fi
172 303
173 # Manual document installation 304 # Manual document installation
174 [[ -n "${DOCS}" ]] && dodoc ${DOCS} 305 [[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; }
306 [[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; }
175} 307}
176 308
177# @FUNCTION: cmake-utils_src_test 309# @FUNCTION: cmake-utils_src_test
178# @DESCRIPTION: 310# @DESCRIPTION:
179# Function for testing the package. Automatically detects the build type. 311# Function for testing the package. Automatically detects the build type.
180cmake-utils_src_test() { 312cmake-utils_src_test() {
181 debug-print-function $FUNCNAME $* 313 debug-print-function ${FUNCNAME} "$@"
182 314
183 # At this point we can automatically check if it's an out-of-source or an 315 _check_build_dir
184 # in-source build 316 pushd "${CMAKE_BUILD_DIR}" > /dev/null
185 if [[ -d ${WORKDIR}/${PN}_build ]]; then
186 pushd "${WORKDIR}"/${PN}_build > /dev/null
187 fi
188 # Standard implementation of src_test 317 # Standard implementation of src_test
189 if emake -j1 check -n &> /dev/null; then 318 if emake -j1 check -n &> /dev/null; then
190 einfo ">>> Test phase [check]: ${CATEGORY}/${PF}" 319 einfo ">>> Test phase [check]: ${CATEGORY}/${PF}"
191 if ! emake -j1 check; then 320 if ! emake -j1 check; then
192 die "Make check failed. See above for details." 321 die "Make check failed. See above for details."
197 die "Make test failed. See above for details." 326 die "Make test failed. See above for details."
198 fi 327 fi
199 else 328 else
200 einfo ">>> Test phase [none]: ${CATEGORY}/${PF}" 329 einfo ">>> Test phase [none]: ${CATEGORY}/${PF}"
201 fi 330 fi
202 if [[ -d ${WORKDIR}/${PN}_build ]]; then
203 popd > /dev/null 331 popd > /dev/null
204 fi
205} 332}

Legend:
Removed from v.1.6  
changed lines
  Added in v.1.22

  ViewVC Help
Powered by ViewVC 1.1.20