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

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.17

  ViewVC Help
Powered by ViewVC 1.1.20