/[gentoo-x86]/eclass/wxwidgets.eclass
Gentoo

Diff of /eclass/wxwidgets.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.31 Revision 1.37
1# Copyright 1999-2007 Gentoo Foundation 1# Copyright 1999-2013 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/wxwidgets.eclass,v 1.31 2011/07/17 19:58:39 dirtyepic Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/wxwidgets.eclass,v 1.37 2013/11/16 13:05:11 dirtyepic Exp $
4 4
5# @ECLASS: wxwidgets.eclass 5# @ECLASS: wxwidgets.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# wxwidgets@gentoo.org 7# wxwidgets@gentoo.org
8# @BLURB: Manages build configuration for wxGTK-using packages. 8# @BLURB: Manages build configuration for wxGTK-using packages.
9# @DESCRIPTION: 9# @DESCRIPTION:
10# The wxGTK libraries come in several different possible configurations 10# This eclass gives ebuilds the ability to build against a specific wxGTK
11# (release, debug, ansi, unicode, etc.) most of which can be installed 11# SLOT and profile without interfering with the system configuration. Any
12# side-by-side. The purpose of this eclass is to provide ebuilds the ability 12# ebuild with a x11-libs/wxGTK dependency must use this eclass.
13# to build against a specific type of profile without interfering with the
14# user-set system configuration.
15# 13#
16# Ebuilds that use wxGTK _must_ inherit this eclass. 14# There are two ways to do it:
17# 15#
18# - Using this eclass - 16# - set WX_GTK_VER before inheriting the eclass
17# - set WX_GTK_VER and call need-wxwidgets from a phase function
19# 18#
20# 1. set WX_GTK_VER to a valid wxGTK SLOT 19# (where WX_GTK_VER is the SLOT you want)
21# 2. inherit wxwidgets 20#
22# 3. add an appropriate DEPEND 21# If your package has optional support for wxGTK (ie. by a USE flag) then
23# 4. done 22# you should use need-wxwidgets. This is important because some packages
23# will force-enable wxGTK if they find WX_CONFIG set in the environment.
24# 24#
25# @CODE 25# @CODE
26# WX_GTK_VER="2.8" 26# inherit wxwidgets
27# 27#
28# inherit wxwidgets 28# IUSE="X wxwidgets"
29# DEPEND="wxwidgets? ( x11-libs/wxGTK:2.8[X?] )"
29# 30#
30# DEPEND="x11-libs/wxGTK:2.8[X]" 31# src_configure() {
31# RDEPEND="${DEPEND}" 32# if use wxwidgets; then
32# [...] 33# WX_GTK_VER="2.8"
34# if use X; then
35# need-wxwidgets unicode
36# else
37# need-wxwidgets base-unicode
38# fi
39# fi
40# econf --with-wx-config="${WX_CONFIG}"
41# }
33# @CODE 42# @CODE
34# 43#
35# This will get you the default configuration, which is what you want 99% 44# That's about as complicated as it gets. 99% of ebuilds can get away with:
36# of the time (in 2.6 the default is "ansi", all other versions default to
37# "unicode").
38# 45#
39# If your package has optional wxGTK support controlled by a USE flag or you 46# @CODE
40# need to use the wxBase libraries (USE="-X") then you should not set 47# inherit wxwidgets
41# WX_GTK_VER before inherit and instead refer to the need-wxwidgets function 48# DEPEND="wxwidgets? ( x11-libs/wxGTK:2.8[X] )
42# below. 49# ...
50# WX_GTK_VER=2.8 need-wxwidgets unicode
51# @CODE
43# 52#
44# The variable WX_CONFIG is exported, containing the absolute path to the 53# Note: unless you know your package works with wxbase (which is very
45# wx-config file to use. Most configure scripts use this path if it's set in 54# doubtful), always depend on wxGTK[X].
46# the environment or accept --with-wx-config="${WX_CONFIG}".
47 55
48inherit eutils multilib 56inherit eutils multilib
49 57
50case "${EAPI:-0}" in
51 0|1)
52 EXPORT_FUNCTIONS pkg_setup
53 ;;
54 *)
55 ;;
56esac
57
58# We do this globally so ebuilds can get sane defaults just by inheriting. They 58# We do this in global scope so ebuilds can get sane defaults just by
59# can be overridden with need-wxwidgets later if need be. 59# inheriting.
60
61# ensure this only runs once
62if [[ -z ${WX_CONFIG} ]]; then 60if [[ -z ${WX_CONFIG} ]]; then
63 # and only if WX_GTK_VER is set before inherit
64 if [[ -n ${WX_GTK_VER} ]]; then 61 if [[ -n ${WX_GTK_VER} ]]; then
65 if [[ ${WX_GTK_VER} == 2.6 ]]; then
66 wxchar="ansi"
67 else
68 wxchar="unicode"
69 fi
70 for wxtoolkit in gtk2 base; do 62 for wxtoolkit in gtk2 base; do
71 # newer versions don't have a seperate debug profile 63 # newer versions don't have a seperate debug profile
72 for wxdebug in xxx release- debug-; do 64 for wxdebug in xxx release- debug-; do
73 wxconf="${wxtoolkit}-${wxchar}-${wxdebug/xxx/}${WX_GTK_VER}" 65 wxconf="${wxtoolkit}-unicode-${wxdebug/xxx/}${WX_GTK_VER}"
66
74 if [[ -f /usr/$(get_libdir)/wx/config/${wxconf} ]]; then 67 [[ -f ${EPREFIX}/usr/$(get_libdir)/wx/config/${wxconf} ]] || continue
75 # if this is a wxBase install, die in pkg_setup 68
76 [[ ${wxtoolkit} == "base" ]] && WXBASE_DIE=1
77 else
78 continue
79 fi
80 WX_CONFIG="/usr/$(get_libdir)/wx/config/${wxconf}" 69 WX_CONFIG="${EPREFIX}/usr/$(get_libdir)/wx/config/${wxconf}"
81 WX_ECLASS_CONFIG="${WX_CONFIG}" 70 WX_ECLASS_CONFIG="${WX_CONFIG}"
82 break 71 break
83 done 72 done
84 [[ -n ${WX_CONFIG} ]] && break 73 [[ -n ${WX_CONFIG} ]] && break
85 done 74 done
86 [[ -n ${WX_CONFIG} ]] && export WX_CONFIG WX_ECLASS_CONFIG 75 [[ -n ${WX_CONFIG} ]] && export WX_CONFIG WX_ECLASS_CONFIG
87 fi 76 fi
88fi 77fi
89 78
90# @FUNCTION: wxwidgets_pkg_setup
91# @DESCRIPTION:
92#
93# It's possible for wxGTK to be installed with USE="-X", resulting in something
94# called wxBase. There's only ever been a couple packages in the tree that use
95# wxBase so this is probably not what you want. Whenever possible, use EAPI 2
96# USE dependencies(tm) to ensure that wxGTK was built with USE="X". This
97# function is only exported for EAPI 0 or 1 and catches any remaining cases.
98#
99# If you do use wxBase, don't set WX_GTK_VER before inherit. Use
100# need-wxwidgets() instead.
101
102wxwidgets_pkg_setup() {
103 [[ -n $WXBASE_DIE ]] && check_wxuse X
104}
105
106# @FUNCTION: need-wxwidgets 79# @FUNCTION: need-wxwidgets
107# @USAGE: <configuration> 80# @USAGE: <profile>
108# @DESCRIPTION: 81# @DESCRIPTION:
109# 82#
110# Available configurations are: 83# Available configurations are:
111# 84#
112# [2.6] ansi [>=2.8] unicode 85# unicode (USE="X")
113# unicode base-unicode 86# base-unicode (USE="-X")
114# base
115# base-unicode
116#
117# If your package has optional wxGTK support controlled by a USE flag, set
118# WX_GTK_VER inside a conditional rather than before inherit. Some broken
119# configure scripts will force wxGTK on if they find ${WX_CONFIG} set.
120#
121# @CODE
122# src_configure() {
123# if use wxwidgets; then
124# WX_GTK_VER="2.8"
125# if use X; then
126# need-wxwidgets unicode
127# else
128# need-wxwidgets base-unicode
129# fi
130# fi
131# @CODE
132#
133 87
134need-wxwidgets() { 88need-wxwidgets() {
135 debug-print-function $FUNCNAME $*
136
137 local wxtoolkit wxchar wxdebug wxconf 89 local wxtoolkit wxdebug wxconf
138 90
139 if [[ -z ${WX_GTK_VER} ]]; then 91 if [[ -z ${WX_GTK_VER} ]]; then
140 echo
141 eerror "WX_GTK_VER must be set before calling $FUNCNAME." 92 eerror "WX_GTK_VER must be set before calling $FUNCNAME."
142 echo 93 echo
143 die "WX_GTK_VER missing" 94 die
95 fi
96
97 if [[ ${WX_GTK_VER} != 2.8 && ${WX_GTK_VER} != 2.9 ]]; then
98 eerror "Invalid WX_GTK_VER: ${WX_GTK_VER} - must be set to a valid wxGTK SLOT."
99 echo
100 die
144 fi 101 fi
145 102
146 if [[ ${WX_GTK_VER} != 2.6 && ${WX_GTK_VER} != 2.8 && ${WX_GTK_VER} != 2.9 ]]; then 103 case $1 in
104 unicode|base-unicode) ;;
105 *) eerror "Invalid $FUNCNAME profile: $1"
147 echo 106 echo
148 eerror "Invalid WX_GTK_VER: ${WX_GTK_VER} - must be set to a valid wxGTK SLOT." 107 die
149 echo
150 die "Invalid WX_GTK_VER"
151 fi
152
153 debug-print "WX_GTK_VER is ${WX_GTK_VER}"
154
155 case $1 in
156 ansi)
157 debug-print-section ansi
158 if [[ ${WX_GTK_VER} == 2.6 ]]; then
159 wxchar="ansi"
160 else
161 wxchar="unicode"
162 fi
163 check_wxuse X
164 ;;
165 unicode)
166 debug-print-section unicode
167 check_wxuse X
168 [[ ${WX_GTK_VER} == 2.6 ]] && check_wxuse unicode
169 wxchar="unicode"
170 ;;
171 base)
172 debug-print-section base
173 if [[ ${WX_GTK_VER} == 2.6 ]]; then
174 wxchar="ansi"
175 else
176 wxchar="unicode"
177 fi
178 ;;
179 base-unicode)
180 debug-print-section base-unicode
181 [[ ${WX_GTK_VER} == 2.6 ]] && check_wxuse unicode
182 wxchar="unicode"
183 ;;
184 # backwards compatibility
185 gtk2)
186 debug-print-section gtk2
187 if [[ ${WX_GTK_VER} == 2.6 ]]; then
188 wxchar="ansi"
189 else
190 wxchar="unicode"
191 fi
192 check_wxuse X
193 ;;
194 *)
195 echo
196 eerror "Invalid $FUNCNAME argument: $1"
197 echo
198 die "Invalid argument"
199 ;; 108 ;;
200 esac 109 esac
201 110
202 debug-print "wxchar is ${wxchar}"
203
204 # TODO: remove built_with_use
205
206 # wxBase can be provided by both gtk2 and base installations 111 # wxbase is provided by both gtk2 and base installations
207 if built_with_use =x11-libs/wxGTK-${WX_GTK_VER}* X; then 112 if has_version "x11-libs/wxGTK:${WX_GTK_VER}[X]"; then
208 wxtoolkit="gtk2" 113 wxtoolkit="gtk2"
209 else 114 else
210 wxtoolkit="base" 115 wxtoolkit="base"
211 fi 116 fi
212 117
213 debug-print "wxtoolkit is ${wxtoolkit}" 118 # 2.8 has a separate debug tuple
214
215 # debug or release?
216 if [[ ${WX_GTK_VER} == 2.6 || ${WX_GTK_VER} == 2.8 ]]; then 119 if [[ ${WX_GTK_VER} == 2.8 ]]; then
217 if built_with_use =x11-libs/wxGTK-${WX_GTK_VER}* debug; then 120 if has_version "x11-libs/wxGTK:${WX_GTK_VER}[debug]"; then
218 wxdebug="debug-" 121 wxdebug="debug-"
219 else 122 else
220 wxdebug="release-" 123 wxdebug="release-"
221 fi 124 fi
222 fi 125 fi
223 126
224 debug-print "wxdebug is ${wxdebug}" 127 wxconf="${wxtoolkit}-unicode-${wxdebug}${WX_GTK_VER}"
225 128
226 # put it all together
227 wxconf="${wxtoolkit}-${wxchar}-${wxdebug}${WX_GTK_VER}"
228
229 debug-print "wxconf is ${wxconf}"
230
231 # if this doesn't work, something is seriously screwed
232 if [[ ! -f /usr/$(get_libdir)/wx/config/${wxconf} ]]; then 129 if [[ ! -f ${EPREFIX}/usr/$(get_libdir)/wx/config/${wxconf} ]]; then
233 echo 130 echo
234 eerror "Failed to find configuration ${wxconf}" 131 eerror "Failed to find configuration ${wxconf}"
235 echo 132 echo
236 die "Missing wx-config" 133 die
237 fi 134 fi
238 135
239 debug-print "Found config ${wxconf} - setting WX_CONFIG"
240
241 export WX_CONFIG="/usr/$(get_libdir)/wx/config/${wxconf}" 136 export WX_CONFIG="${EPREFIX}/usr/$(get_libdir)/wx/config/${wxconf}"
242
243 debug-print "WX_CONFIG is ${WX_CONFIG}"
244
245 export WX_ECLASS_CONFIG="${WX_CONFIG}" 137 export WX_ECLASS_CONFIG="${WX_CONFIG}"
246 138
247 echo 139 echo
248 einfo "Requested wxWidgets: ${1} ${WX_GTK_VER}" 140 einfo "Requested wxWidgets: ${1} ${WX_GTK_VER}"
249 einfo "Using wxWidgets: ${wxconf}" 141 einfo "Using wxWidgets: ${wxconf}"
250 echo 142 echo
251} 143}
252
253
254# @FUNCTION: check_wxuse
255# @USAGE: <USE flag>
256# @DESCRIPTION:
257#
258# Provides a consistant way to check if wxGTK was built with a particular USE
259# flag enabled. A better way is EAPI 2 USE dependencies (hint hint).
260
261check_wxuse() {
262 debug-print-function $FUNCNAME $*
263
264 if [[ -z ${WX_GTK_VER} ]]; then
265 echo
266 eerror "WX_GTK_VER must be set before calling $FUNCNAME."
267 echo
268 die "WX_GTK_VER missing"
269 fi
270
271 # TODO: Remove built_with_use
272
273 ebegin "Checking wxGTK-${WX_GTK_VER} for ${1} support"
274 if built_with_use =x11-libs/wxGTK-${WX_GTK_VER}* "${1}"; then
275 eend 0
276 else
277 eend 1
278 echo
279 eerror "${FUNCNAME} - You have requested functionality that requires ${1} support to"
280 eerror "have been built into x11-libs/wxGTK."
281 eerror
282 eerror "Please re-merge =x11-libs/wxGTK-${WX_GTK_VER}* with the ${1} USE flag enabled."
283 die "Missing USE flags."
284 fi
285}

Legend:
Removed from v.1.31  
changed lines
  Added in v.1.37

  ViewVC Help
Powered by ViewVC 1.1.20