1 |
# Copyright 1999-2007 Gentoo Foundation |
2 |
# Distributed under the terms of the GNU General Public License v2 |
3 |
# $Header: $ |
4 |
|
5 |
# @ECLASS: cmake-utils.eclass |
6 |
# @MAINTAINER: |
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) |
13 |
# @BLURB: common ebuild functions for cmake-based packages |
14 |
# @DESCRIPTION: |
15 |
# The cmake-utils eclass contains functions that make creating ebuilds for |
16 |
# cmake-based packages much easier. |
17 |
# Its main features are support of out-of-source builds as well as in-source |
18 |
# builds and an implementation of the well-known use_enable and use_with |
19 |
# functions for CMake. |
20 |
|
21 |
inherit toolchain-funcs multilib flag-o-matic base |
22 |
|
23 |
EXPF="src_compile src_test src_install" |
24 |
case ${EAPI:-0} in |
25 |
2) EXPF="${EXPF} src_configure" |
26 |
;; |
27 |
1|0) ;; |
28 |
*) die "Unknown EAPI, Bug eclass maintainers." ;; |
29 |
esac |
30 |
EXPORT_FUNCTIONS ${EXPF} |
31 |
|
32 |
: ${DESCRIPTION:="Based on the ${ECLASS} eclass"} |
33 |
|
34 |
DEPEND=">=dev-util/cmake-2.4.6-r1" |
35 |
|
36 |
# Internal functions used by cmake-utils_use_* |
37 |
_use_me_now() { |
38 |
debug-print-function ${FUNCNAME} "$@" |
39 |
[[ -z $2 ]] && die "cmake-utils_use-$1 <USE flag> [<flag name>]" |
40 |
echo "-D$1_${3:-$2}=$(use $2 && echo ON || echo OFF)" |
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 |
} |
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 |
} |
95 |
# @FUNCTION: cmake-utils_use_with |
96 |
# @USAGE: <USE flag> [flag name] |
97 |
# @DESCRIPTION: |
98 |
# Based on use_with. See ebuild(5). |
99 |
# |
100 |
# `cmake-utils_use_with foo FOO` echoes -DWITH_FOO=ON if foo is enabled |
101 |
# and -DWITH_FOO=OFF if it is disabled. |
102 |
cmake-utils_use_with() { _use_me_now WITH "$@" ; } |
103 |
|
104 |
# @FUNCTION: cmake-utils_use_enable |
105 |
# @USAGE: <USE flag> [flag name] |
106 |
# @DESCRIPTION: |
107 |
# Based on use_enable. See ebuild(5). |
108 |
# |
109 |
# `cmake-utils_use_enable foo FOO` echoes -DENABLE_FOO=ON if foo is enabled |
110 |
# and -DENABLE_FOO=OFF if it is disabled. |
111 |
cmake-utils_use_enable() { _use_me_now ENABLE "$@" ; } |
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. |
120 |
cmake-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. |
129 |
cmake-utils_use_no() { _use_me_now_inverted NO "$@" ; } |
130 |
|
131 |
# @FUNCTION: cmake-utils_use_want |
132 |
# @USAGE: <USE flag> [flag name] |
133 |
# @DESCRIPTION: |
134 |
# Based on use_enable. See ebuild(5). |
135 |
# |
136 |
# `cmake-utils_use_want foo FOO` echoes -DWANT_FOO=ON if foo is enabled |
137 |
# and -DWANT_FOO=OFF if it is disabled. |
138 |
cmake-utils_use_want() { _use_me_now WANT "$@" ; } |
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. |
147 |
cmake-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. |
156 |
cmake-utils_use_has() { _use_me_now HAVE "$@" ; } |
157 |
|
158 |
# @FUNCTION: cmake-utils_has |
159 |
# @DESCRIPTION: |
160 |
# Deprecated, use cmake-utils_use_has, kept now for backcompat. |
161 |
cmake-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: |
166 |
# Based on use_enable. See ebuild(5). |
167 |
# |
168 |
# `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled |
169 |
# and -DFOO=OFF if it is disabled. |
170 |
cmake-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 ' |
186 |
MESSAGE(STATUS "<<< Gentoo configuration >>> |
187 |
Build type: ${CMAKE_BUILD_TYPE} |
188 |
Install 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. |
195 |
cmake-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 |
211 |
cat > ${build_rules} << _EOF_ |
212 |
SET (CMAKE_C_COMPILER $(type -P $(tc-getCC)) CACHE FILEPATH "C compiler" FORCE) |
213 |
SET (CMAKE_C_COMPILE_OBJECT "<CMAKE_C_COMPILER> <DEFINES> ${CPPFLAGS} <FLAGS> -o <OBJECT> -c <SOURCE>" CACHE STRING "C compile command" FORCE) |
214 |
SET (CMAKE_CXX_COMPILER $(type -P $(tc-getCXX)) CACHE FILEPATH "C++ compiler" FORCE) |
215 |
SET (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) |
231 |
cat > ${common_config} << _EOF_ |
232 |
SET (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 |
} |
245 |
|
246 |
# @FUNCTION: cmake-utils_src_compile |
247 |
# @DESCRIPTION: |
248 |
# General function for compiling with cmake. Default behaviour is to check for |
249 |
# EAPI and respectively to configure as well or just compile. |
250 |
cmake-utils_src_compile() { |
251 |
debug-print-function ${FUNCNAME} "$@" |
252 |
|
253 |
has src_configure ${EXPF} || cmake-utils_src_configure |
254 |
cmake-utils_src_make "$@" |
255 |
} |
256 |
|
257 |
# @FUNCTION: cmake-utils_src_configurein |
258 |
# @DESCRIPTION: |
259 |
# Deprecated |
260 |
cmake-utils_src_configurein() { |
261 |
ewarn "QA: This ebuild is using deprecated function call: ${FUNCNAME}" |
262 |
ewarn "QA: Inform ebuild maintainer." |
263 |
cmake-utils_src_configure |
264 |
} |
265 |
|
266 |
# @FUNCTION: cmake-utils_src_configureout |
267 |
# @DESCRIPTION: |
268 |
# Deprecated |
269 |
cmake-utils_src_configureout() { |
270 |
ewarn "QA: This ebuild is using deprecated function call: ${FUNCNAME}" |
271 |
ewarn "QA: Inform ebuild maintainer." |
272 |
cmake-utils_src_configure |
273 |
} |
274 |
|
275 |
# @FUNCTION: cmake-utils_src_make |
276 |
# @DESCRIPTION: |
277 |
# Function for building the package. Automatically detects the build type. |
278 |
# All arguments are passed to emake: |
279 |
cmake-utils_src_make() { |
280 |
debug-print-function ${FUNCNAME} "$@" |
281 |
|
282 |
_check_build_dir |
283 |
pushd "${CMAKE_BUILD_DIR}" > /dev/null |
284 |
if [[ -n ${CMAKE_VERBOSE} ]]; then |
285 |
emake VERBOSE=1 "$@" || die "Make failed!" |
286 |
else |
287 |
emake "$@" || die "Make failed!" |
288 |
fi |
289 |
popd > /dev/null |
290 |
} |
291 |
|
292 |
# @FUNCTION: cmake-utils_src_install |
293 |
# @DESCRIPTION: |
294 |
# Function for installing the package. Automatically detects the build type. |
295 |
cmake-utils_src_install() { |
296 |
debug-print-function ${FUNCNAME} "$@" |
297 |
|
298 |
_check_build_dir |
299 |
pushd "${CMAKE_BUILD_DIR}" > /dev/null |
300 |
emake install DESTDIR="${D}" || die "Make install failed" |
301 |
popd > /dev/null |
302 |
|
303 |
# Manual document installation |
304 |
[[ -n "${DOCS}" ]] && { dodoc ${DOCS} || die "dodoc failed" ; } |
305 |
[[ -n "${HTML_DOCS}" ]] && { dohtml -r ${HTML_DOCS} || die "dohtml failed" ; } |
306 |
} |
307 |
|
308 |
# @FUNCTION: cmake-utils_src_test |
309 |
# @DESCRIPTION: |
310 |
# Function for testing the package. Automatically detects the build type. |
311 |
cmake-utils_src_test() { |
312 |
debug-print-function ${FUNCNAME} "$@" |
313 |
|
314 |
_check_build_dir |
315 |
pushd "${CMAKE_BUILD_DIR}" > /dev/null |
316 |
# Standard implementation of src_test |
317 |
if emake -j1 check -n &> /dev/null; then |
318 |
einfo ">>> Test phase [check]: ${CATEGORY}/${PF}" |
319 |
if ! emake -j1 check; then |
320 |
die "Make check failed. See above for details." |
321 |
fi |
322 |
elif emake -j1 test -n &> /dev/null; then |
323 |
einfo ">>> Test phase [test]: ${CATEGORY}/${PF}" |
324 |
if ! emake -j1 test; then |
325 |
die "Make test failed. See above for details." |
326 |
fi |
327 |
else |
328 |
einfo ">>> Test phase [none]: ${CATEGORY}/${PF}" |
329 |
fi |
330 |
popd > /dev/null |
331 |
} |