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