/[gentoo-x86]/eclass/gnome2-utils.eclass
Gentoo

Contents of /eclass/gnome2-utils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.23 - (show annotations) (download)
Mon Aug 22 04:46:31 2011 UTC (3 years, 2 months ago) by vapier
Branch: MAIN
Changes since 1.22: +3 -3 lines
fix random bugs in eclass documentation, and convert to new @AUTHOR tag

1 # Copyright 1999-2011 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/gnome2-utils.eclass,v 1.22 2011/04/03 18:12:34 eva Exp $
4
5 # @ECLASS: gnome2-utils.eclass
6 # @MAINTAINER:
7 # gnome@gentoo.org
8 # @BLURB: Auxiliary functions commonly used by Gnome packages.
9 # @DESCRIPTION:
10 # This eclass provides a set of auxiliary functions needed by most Gnome
11 # packages. It may be used by non-Gnome packages as needed for handling various
12 # Gnome stack related functions such as:
13 # * Gtk+ icon cache management
14 # * GSettings schemas management
15 # * GConf schemas management
16 # * scrollkeeper (old Gnome help system) management
17
18 case "${EAPI:-0}" in
19 0|1|2|3|4) ;;
20 *) die "EAPI=${EAPI} is not supported" ;;
21 esac
22
23 # @ECLASS-VARIABLE: GCONFTOOL_BIN
24 # @INTERNAL
25 # @DESCRIPTION:
26 # Path to gconftool-2
27 : ${GCONFTOOL_BIN:="/usr/bin/gconftool-2"}
28
29 # @ECLASS-VARIABLE: SCROLLKEEPER_DIR
30 # @INTERNAL
31 # @DESCRIPTION:
32 # Directory where scrollkeeper-update should do its work
33 : ${SCROLLKEEPER_DIR:="/var/lib/scrollkeeper"}
34
35 # @ECLASS-VARIABLE: SCROLLKEEPER_UPDATE_BIN
36 # @INTERNAL
37 # @DESCRIPTION:
38 # Path to scrollkeeper-update
39 : ${SCROLLKEEPER_UPDATE_BIN:="/usr/bin/scrollkeeper-update"}
40
41 # @ECLASS-VARIABLE: GTK_UPDATE_ICON_CACHE
42 # @INTERNAL
43 # @DESCRIPTION:
44 # Path to gtk-update-icon-cache
45 : ${GTK_UPDATE_ICON_CACHE:="/usr/bin/gtk-update-icon-cache"}
46
47 # @ECLASS-VARIABLE: GLIB_COMPILE_SCHEMAS
48 # @INTERNAL
49 # @DESCRIPTION:
50 # Path to glib-compile-schemas
51 : ${GLIB_COMPILE_SCHEMAS:="/usr/bin/glib-compile-schemas"}
52
53 # @ECLASS-VARIABLE: GNOME2_ECLASS_SCHEMAS
54 # @INTERNAL
55 # @DEFAULT_UNSET
56 # @DESCRIPTION:
57 # List of GConf schemas provided by the package
58
59 # @ECLASS-VARIABLE: GNOME2_ECLASS_ICONS
60 # @INTERNAL
61 # @DEFAULT_UNSET
62 # @DESCRIPTION:
63 # List of icons provided by the package
64
65 # @ECLASS-VARIABLE: GNOME2_ECLASS_GLIB_SCHEMAS
66 # @INTERNAL
67 # @DEFAULT_UNSET
68 # @DESCRIPTION:
69 # List of GSettings schemas provided by the package
70
71
72 DEPEND=">=sys-apps/sed-4"
73
74
75 # @FUNCTION: gnome2_gconf_savelist
76 # @DESCRIPTION:
77 # Find the GConf schemas that are about to be installed and save their location
78 # in the GNOME2_ECLASS_SCHEMAS environment variable.
79 # This function should be called from pkg_preinst.
80 gnome2_gconf_savelist() {
81 has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}"
82 pushd "${ED}" &> /dev/null
83 export GNOME2_ECLASS_SCHEMAS=$(find 'etc/gconf/schemas/' -name '*.schemas' 2> /dev/null)
84 popd &> /dev/null
85 }
86
87 # @FUNCTION: gnome2_gconf_install
88 # @DESCRIPTION:
89 # Applies any schema files installed by the current ebuild to Gconf's database
90 # using gconftool-2.
91 # This function should be called from pkg_postinst.
92 gnome2_gconf_install() {
93 has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}"
94 local updater="${EROOT}${GCONFTOOL_BIN}"
95
96 if [[ ! -x "${updater}" ]]; then
97 debug-print "${updater} is not executable"
98 return
99 fi
100
101 if [[ -z "${GNOME2_ECLASS_SCHEMAS}" ]]; then
102 debug-print "No GNOME 2 GConf schemas found"
103 return
104 fi
105
106 # We are ready to install the GCONF Scheme now
107 unset GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL
108 export GCONF_CONFIG_SOURCE="$("${updater}" --get-default-source | sed "s;:/;:${ROOT};")"
109
110 einfo "Installing GNOME 2 GConf schemas"
111
112 local F
113 for F in ${GNOME2_ECLASS_SCHEMAS}; do
114 if [[ -e "${EROOT}${F}" ]]; then
115 debug-print "Installing schema: ${F}"
116 "${updater}" --makefile-install-rule "${EROOT}${F}" 1>/dev/null
117 fi
118 done
119
120 # have gconf reload the new schemas
121 pids=$(pgrep -x gconfd-2)
122 if [[ $? == 0 ]] ; then
123 ebegin "Reloading GConf schemas"
124 kill -HUP ${pids}
125 eend $?
126 fi
127 }
128
129 # @FUNCTION: gnome2_gconf_uninstall
130 # @DESCRIPTION:
131 # Removes schema files previously installed by the current ebuild from Gconf's
132 # database.
133 gnome2_gconf_uninstall() {
134 has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}"
135 local updater="${EROOT}${GCONFTOOL_BIN}"
136
137 if [[ ! -x "${updater}" ]]; then
138 debug-print "${updater} is not executable"
139 return
140 fi
141
142 if [[ -z "${GNOME2_ECLASS_SCHEMAS}" ]]; then
143 debug-print "No GNOME 2 GConf schemas found"
144 return
145 fi
146
147 unset GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL
148 export GCONF_CONFIG_SOURCE="$("${updater}" --get-default-source | sed "s;:/;:${ROOT};")"
149
150 einfo "Uninstalling GNOME 2 GConf schemas"
151
152 local F
153 for F in ${GNOME2_ECLASS_SCHEMAS}; do
154 if [[ -e "${EROOT}${F}" ]]; then
155 debug-print "Uninstalling gconf schema: ${F}"
156 "${updater}" --makefile-uninstall-rule "${EROOT}${F}" 1>/dev/null
157 fi
158 done
159
160 # have gconf reload the new schemas
161 pids=$(pgrep -x gconfd-2)
162 if [[ $? == 0 ]] ; then
163 ebegin "Reloading GConf schemas"
164 kill -HUP ${pids}
165 eend $?
166 fi
167 }
168
169 # @FUNCTION: gnome2_icon_savelist
170 # @DESCRIPTION:
171 # Find the icons that are about to be installed and save their location
172 # in the GNOME2_ECLASS_ICONS environment variable.
173 # This function should be called from pkg_preinst.
174 gnome2_icon_savelist() {
175 has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}"
176 pushd "${ED}" &> /dev/null
177 export GNOME2_ECLASS_ICONS=$(find 'usr/share/icons' -maxdepth 1 -mindepth 1 -type d 2> /dev/null)
178 popd &> /dev/null
179 }
180
181 # @FUNCTION: gnome2_icon_cache_update
182 # @DESCRIPTION:
183 # Updates Gtk+ icon cache files under /usr/share/icons if the current ebuild
184 # have installed anything under that location.
185 # This function should be called from pkg_postinst and pkg_postrm.
186 gnome2_icon_cache_update() {
187 has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}"
188 local updater="${EROOT}${GTK_UPDATE_ICON_CACHE}"
189
190 if [[ ! -x "${updater}" ]] ; then
191 debug-print "${updater} is not executable"
192 return
193 fi
194
195 if [[ -z "${GNOME2_ECLASS_ICONS}" ]]; then
196 debug-print "No icon cache to update"
197 return
198 fi
199
200 ebegin "Updating icons cache"
201
202 local retval=0
203 local fails=( )
204
205 for dir in ${GNOME2_ECLASS_ICONS}
206 do
207 if [[ -f "${EROOT}${dir}/index.theme" ]] ; then
208 local rv=0
209
210 "${updater}" -qf "${EROOT}${dir}"
211 rv=$?
212
213 if [[ ! $rv -eq 0 ]] ; then
214 debug-print "Updating cache failed on ${EROOT}${dir}"
215
216 # Add to the list of failures
217 fails[$(( ${#fails[@]} + 1 ))]="${EROOT}${dir}"
218
219 retval=2
220 fi
221 fi
222 done
223
224 eend ${retval}
225
226 for f in "${fails[@]}" ; do
227 eerror "Failed to update cache with icon $f"
228 done
229 }
230
231 # @FUNCTION: gnome2_omf_fix
232 # @DESCRIPTION:
233 # Workaround applied to Makefile rules in order to remove redundant
234 # calls to scrollkeeper-update and sandbox violations.
235 # This function should be called from src_prepare.
236 gnome2_omf_fix() {
237 local omf_makefiles filename
238
239 omf_makefiles="$@"
240
241 if [[ -f ${S}/omf.make ]] ; then
242 omf_makefiles="${omf_makefiles} ${S}/omf.make"
243 fi
244
245 # testing fixing of all makefiles found
246 # The sort is important to ensure .am is listed before the respective .in for
247 # maintainer mode regeneration not kicking in due to .am being newer than .in
248 for filename in $(find ./ -name "Makefile.in" -o -name "Makefile.am" |sort) ; do
249 omf_makefiles="${omf_makefiles} ${filename}"
250 done
251
252 ebegin "Fixing OMF Makefiles"
253
254 local retval=0
255 local fails=( )
256
257 for omf in ${omf_makefiles} ; do
258 local rv=0
259
260 sed -i -e 's:scrollkeeper-update:true:' "${omf}"
261 retval=$?
262
263 if [[ ! $rv -eq 0 ]] ; then
264 debug-print "updating of ${omf} failed"
265
266 # Add to the list of failures
267 fails[$(( ${#fails[@]} + 1 ))]=$omf
268
269 retval=2
270 fi
271 done
272
273 eend $retval
274
275 for f in "${fails[@]}" ; do
276 eerror "Failed to update OMF Makefile $f"
277 done
278 }
279
280 # @FUNCTION: gnome2_scrollkeeper_update
281 # @DESCRIPTION:
282 # Updates the global scrollkeeper database.
283 # This function should be called from pkg_postinst and pkg_postrm.
284 gnome2_scrollkeeper_update() {
285 has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}"
286 if [[ -x "${EROOT}${SCROLLKEEPER_UPDATE_BIN}" ]]; then
287 einfo "Updating scrollkeeper database ..."
288 "${EROOT}${SCROLLKEEPER_UPDATE_BIN}" -q -p "${EROOT}${SCROLLKEEPER_DIR}"
289 fi
290 }
291
292 # @FUNCTION: gnome2_schemas_savelist
293 # @DESCRIPTION:
294 # Find if there is any GSettings schema to install and save the list in
295 # GNOME2_ECLASS_GLIB_SCHEMAS variable.
296 # This function should be called from pkg_preinst.
297 gnome2_schemas_savelist() {
298 has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}"
299 pushd "${ED}" &>/dev/null
300 export GNOME2_ECLASS_GLIB_SCHEMAS=$(find 'usr/share/glib-2.0/schemas' -name '*.gschema.xml' 2>/dev/null)
301 popd &>/dev/null
302 }
303
304 # @FUNCTION: gnome2_schemas_update
305 # @USAGE: gnome2_schemas_update [--uninstall]
306 # @DESCRIPTION:
307 # Updates GSettings schemas if GNOME2_ECLASS_GLIB_SCHEMAS has some.
308 # This function should be called from pkg_postinst and pkg_postrm with --uninstall.
309 gnome2_schemas_update() {
310 has ${EAPI:-0} 0 1 2 && ! use prefix && EROOT="${ROOT}"
311 local updater="${EROOT}${GLIB_COMPILE_SCHEMAS}"
312
313 if [[ ! -x ${updater} ]]; then
314 debug-print "${updater} is not executable"
315 return
316 fi
317
318 if [[ -z ${GNOME2_ECLASS_GLIB_SCHEMAS} ]]; then
319 debug-print "No GSettings schemas to update"
320 return
321 fi
322
323 ebegin "Updating GSettings schemas"
324 ${updater} --allow-any-name "$@" "${EROOT%/}/usr/share/glib-2.0/schemas" &>/dev/null
325 eend $?
326 }

  ViewVC Help
Powered by ViewVC 1.1.20