1 # Copyright 1999-2015 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
5 # @ECLASS: gnome2.eclass
8 # @BLURB: Provides phases for Gnome/Gtk+ based packages.
10 # Exports portage base functions used by ebuilds written for packages using the
11 # GNOME framework. For additional functions, see gnome2-utils.eclass.
13 inherit eutils libtool gnome.org gnome2-utils xdg
17 EXPORT_FUNCTIONS src_unpack src_prepare src_configure src_compile src_install pkg_preinst pkg_postinst pkg_postrm
19 *) die "EAPI=${EAPI} is not supported" ;;
22 # @ECLASS-VARIABLE: G2CONF
25 # Extra configure opts passed to econf.
26 # Deprecated, pass extra arguments to gnome2_src_configure.
29 # @ECLASS-VARIABLE: GNOME2_LA_PUNT
31 # Should we delete ALL the .la files?
32 # NOT to be used without due consideration.
33 if has ${EAPI:-0} 4; then
34 GNOME2_LA_PUNT=${GNOME2_LA_PUNT:-"no"}
36 GNOME2_LA_PUNT=${GNOME2_LA_PUNT:-""}
39 # @ECLASS-VARIABLE: ELTCONF
42 # Extra options passed to elibtoolize
43 ELTCONF=${ELTCONF:-""}
45 # @ECLASS-VARIABLE: DOCS
48 # String containing documents passed to dodoc command.
50 # @ECLASS-VARIABLE: GCONF_DEBUG
53 # Whether to handle debug or not.
54 # Some gnome applications support various levels of debugging (yes, no, minimum,
55 # etc), but using --disable-debug also removes g_assert which makes debugging
56 # harder. This variable should be set to yes for such packages for the eclass
57 # to handle it properly. It will enable minimal debug with USE=-debug.
58 # Note that this is most commonly found in configure.ac as GNOME_DEBUG_CHECK.
60 # @ECLASS-VARIABLE: GNOME2_ECLASS_GIO_MODULES
63 # Array containing glib GIO modules
65 if [[ ${GCONF_DEBUG} != "no" ]]; then
69 # @FUNCTION: gnome2_src_unpack
71 # Stub function for old EAPI.
77 # @FUNCTION: gnome2_src_prepare
79 # Prepare environment for build, fix build of scrollkeeper documentation,
81 gnome2_src_prepare() {
84 # Prevent assorted access violations and test failures
85 gnome2_environment_reset
87 # Prevent scrollkeeper access violations
90 # Disable all deprecation warnings
91 gnome2_disable_deprecation_warning
94 # https://bugzilla.gnome.org/show_bug.cgi?id=655517
95 elibtoolize ${ELTCONF}
98 # @FUNCTION: gnome2_src_configure
100 # Gnome specific configure handling
101 gnome2_src_configure() {
102 # Deprecated for a long time now, see Gnome team policies
103 if [[ -n ${G2CONF} ]] ; then
104 eqawarn "G2CONF set, please review documentation at https://wiki.gentoo.org/wiki/Project:GNOME/Gnome_Team_Ebuild_Policies#G2CONF_and_src_configure"
109 # Update the GNOME configuration options
110 if [[ ${GCONF_DEBUG} != 'no' ]] ; then
112 g2conf+=( --enable-debug=yes )
116 # Starting with EAPI=5, we consider packages installing gtk-doc to be
117 # handled by adding DEPEND="dev-util/gtk-doc-am" which provides tools to
118 # relink URLs in documentation to already installed documentation.
119 # This decision also greatly helps with constantly broken doc generation.
120 # Remember to drop 'doc' USE flag from your package if it was only used to
122 # Preserve old behavior for older EAPI.
123 if grep -q "enable-gtk-doc" "${ECONF_SOURCE:-.}"/configure ; then
124 if has ${EAPI:-0} 4 && in_iuse doc ; then
125 g2conf+=( $(use_enable doc gtk-doc) )
127 g2conf+=( --disable-gtk-doc )
131 # Pass --disable-maintainer-mode when needed
132 if grep -q "^[[:space:]]*AM_MAINTAINER_MODE(\[enable\])" \
133 "${ECONF_SOURCE:-.}"/configure.*; then
134 g2conf+=( --disable-maintainer-mode )
137 # Pass --disable-scrollkeeper when possible
138 if grep -q "disable-scrollkeeper" "${ECONF_SOURCE:-.}"/configure; then
139 g2conf+=( --disable-scrollkeeper )
142 # Pass --disable-silent-rules when possible (not needed for eapi5), bug #429308
143 if has ${EAPI:-0} 4; then
144 if grep -q "disable-silent-rules" "${ECONF_SOURCE:-.}"/configure; then
145 g2conf+=( --disable-silent-rules )
149 # Pass --disable-schemas-install when possible
150 if grep -q "disable-schemas-install" "${ECONF_SOURCE:-.}"/configure; then
151 g2conf+=( --disable-schemas-install )
154 # Pass --disable-schemas-compile when possible
155 if grep -q "disable-schemas-compile" "${ECONF_SOURCE:-.}"/configure; then
156 g2conf+=( --disable-schemas-compile )
159 # Pass --disable-update-mimedb when possible
160 if grep -q "disable-update-mimedb" "${ECONF_SOURCE:-.}"/configure; then
161 g2conf+=( --disable-update-mimedb )
164 # Pass --enable-compile-warnings=minimum as we don't want -Werror* flags, bug #471336
165 if grep -q "enable-compile-warnings" "${ECONF_SOURCE:-.}"/configure; then
166 g2conf+=( --enable-compile-warnings=minimum )
169 # Pass --docdir with proper directory, bug #482646
170 if grep -q "^ *--docdir=" "${ECONF_SOURCE:-.}"/configure; then
171 g2conf+=( --docdir="${EPREFIX}"/usr/share/doc/${PF} )
174 # Avoid sandbox violations caused by gnome-vfs (bug #128289 and #345659)
175 addwrite "$(unset HOME; echo ~)/.gnome2"
177 econf ${g2conf[@]} ${G2CONF} "$@"
180 # @FUNCTION: gnome2_src_compile
182 # Only default src_compile for now
183 gnome2_src_compile() {
187 # @FUNCTION: gnome2_src_install
189 # Gnome specific install. Handles typical GConf and scrollkeeper setup
190 # in packages and removal of .la files if requested
191 gnome2_src_install() {
192 # if this is not present, scrollkeeper-update may segfault and
193 # create bogus directories in /var/lib/
194 local sk_tmp_dir="/var/lib/scrollkeeper"
195 dodir "${sk_tmp_dir}" || die "dodir failed"
197 # we must delay gconf schema installation due to sandbox
198 export GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL="1"
200 debug-print "Installing with 'make install'"
201 emake DESTDIR="${D}" "scrollkeeper_localstate_dir=${ED}${sk_tmp_dir} " "$@" install || die "install failed"
203 unset GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL
205 # Handle documentation as 'default' for eapi5 and newer, bug #373131
206 if has ${EAPI:-0} 4; then
207 # Manual document installation
208 if [[ -n "${DOCS}" ]]; then
209 dodoc ${DOCS} || die "dodoc failed"
215 # Do not keep /var/lib/scrollkeeper because:
216 # 1. The scrollkeeper database is regenerated at pkg_postinst()
217 # 2. ${ED}/var/lib/scrollkeeper contains only indexes for the current pkg
218 # thus it makes no sense if pkg_postinst ISN'T run for some reason.
219 rm -rf "${ED}${sk_tmp_dir}"
220 rmdir "${ED}/var/lib" 2>/dev/null
221 rmdir "${ED}/var" 2>/dev/null
223 # Make sure this one doesn't get in the portage db
224 rm -fr "${ED}/usr/share/applications/mimeinfo.cache"
226 # Delete all .la files
227 if has ${EAPI:-0} 4; then
228 if [[ "${GNOME2_LA_PUNT}" != "no" ]]; then
229 ebegin "Removing .la files"
230 if ! use_if_iuse static-libs ; then
231 find "${D}" -name '*.la' -exec rm -f {} + || die "la file removal failed"
236 case "${GNOME2_LA_PUNT}" in
237 yes) prune_libtool_files --modules;;
239 *) prune_libtool_files;;
244 # @FUNCTION: gnome2_pkg_preinst
246 # Finds Icons, GConf and GSettings schemas for later handling in pkg_postinst
247 gnome2_pkg_preinst() {
249 gnome2_gconf_savelist
251 gnome2_schemas_savelist
252 gnome2_scrollkeeper_savelist
253 gnome2_gdk_pixbuf_savelist
257 GNOME2_ECLASS_GIO_MODULES=()
258 while IFS= read -r -d '' f; do
259 GNOME2_ECLASS_GIO_MODULES+=( ${f} )
260 done < <(cd "${D}" && find usr/$(get_libdir)/gio/modules -type f -print0 2>/dev/null)
262 export GNOME2_ECLASS_GIO_MODULES
265 # @FUNCTION: gnome2_pkg_postinst
267 # Handle scrollkeeper, GConf, GSettings, Icons, desktop and mime
269 gnome2_pkg_postinst() {
272 gnome2_icon_cache_update
273 gnome2_schemas_update
274 gnome2_scrollkeeper_update
275 gnome2_gdk_pixbuf_update
277 if [[ ${#GNOME2_ECLASS_GIO_MODULES[@]} -gt 0 ]]; then
278 gnome2_giomodule_cache_update
282 # # FIXME Handle GConf schemas removal
283 #gnome2_pkg_prerm() {
284 # gnome2_gconf_uninstall
287 # @FUNCTION: gnome2_pkg_postrm
289 # Handle scrollkeeper, GSettings, Icons, desktop and mime database updates.
290 gnome2_pkg_postrm() {
292 gnome2_icon_cache_update
293 gnome2_schemas_update
294 gnome2_scrollkeeper_update
296 if [[ ${#GNOME2_ECLASS_GIO_MODULES[@]} -gt 0 ]]; then
297 gnome2_giomodule_cache_update