gentoo-x86/eclass/gnome2.eclass

# Copyright 1999-2011 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/gnome2.eclass,v 1.90 2010/12/07 06:20:40 eva Exp $

# @ECLASS: gnome2.eclass
# @MAINTAINER:
# gnome@gentoo.org
# @BLURB: 
# @DESCRIPTION:
# Exports portage base functions used by ebuilds written for packages using the
# GNOME framework. For additional functions, see gnome2-utils.eclass.

inherit fdo-mime libtool gnome.org gnome2-utils

case "${EAPI:-0}" in
        0|1)
                EXPORT_FUNCTIONS src_unpack src_compile src_install pkg_preinst pkg_postinst pkg_postrm
                ;;
        2|3)
                EXPORT_FUNCTIONS src_unpack src_prepare src_configure src_compile src_install pkg_preinst pkg_postinst pkg_postrm
                ;;
        *) die "EAPI=${EAPI} is not supported" ;;
esac

# @ECLASS-VARIABLE: G2CONF
# @DEFAULT-UNSET
# @DESCRIPTION:
# Extra configure opts passed to econf
G2CONF=${G2CONF:-""}

# @ECLASS-VARIABLE: ELTCONF
# @DEFAULT-UNSET
# @DESCRIPTION:
# Extra options passed to elibtoolize
ELTCONF=${ELTCONF:-""}

# @ECLASS-VARIABLE: USE_EINSTALL
# @DEFAULT-UNSET
# @DEPRECATED
# @DESCRIPTION:
# Should we use EINSTALL instead of DESTDIR
USE_EINSTALL=${USE_EINSTALL:-""}

# @ECLASS-VARIABLE: USE_EINSTALL
# @DEPRECATED
# @DESCRIPTION:
# Whether to run scrollkeeper for this package or not.
SCROLLKEEPER_UPDATE=${SCROLLKEEPER_UPDATE:-"1"}

# @ECLASS-VARIABLE: DOCS
# @DEFAULT-UNSET
# @DESCRIPTION:
# String containing documents passed to dodoc command.

# @ECLASS-VARIABLE: GCONF_DEBUG
# @DEFAULT_UNSET
# @DESCRIPTION:
# Whether to handle debug or not.
# Some gnome applications support various levels of debugging (yes, no, minimum,
# etc), but using --disable-debug also removes g_assert which makes debugging
# harder. This variable should be set to yes for such packages for the eclass
# to handle it properly. It will enable minimal debug with USE=-debug.
# Note that this is most commonly found in configure.ac as GNOME_DEBUG_CHECK.


if [[ ${GCONF_DEBUG} != "no" ]]; then
        IUSE="debug"
fi


# @FUNCTION: gnome2_src_unpack
# @DESCRIPTION:
# Stub function for old EAPI.
gnome2_src_unpack() {
        unpack ${A}
        cd "${S}"
        has ${EAPI:-0} 0 1 && gnome2_src_prepare
}

# @FUNCTION: gnome2_src_prepare
# @DESCRIPTION:
# Fix build of scrollkeeper documentation and run elibtoolize.
gnome2_src_prepare() {
        # Prevent scrollkeeper access violations
        gnome2_omf_fix

        # Run libtoolize
        elibtoolize ${ELTCONF}
}

# @FUNCTION: gnome2_src_configure
# @DESCRIPTION:
# Gnome specific configure handling
gnome2_src_configure() {
        # Update the GNOME configuration options
        if [[ ${GCONF_DEBUG} != 'no' ]] ; then
                if use debug ; then
                        G2CONF="${G2CONF} --enable-debug=yes"
                fi
        fi

        # Prevent a QA warning
        if hasq doc ${IUSE} ; then
                G2CONF="${G2CONF} $(use_enable doc gtk-doc)"
        fi

        # Avoid sandbox violations caused by misbehaving packages (bug #128289)
        addwrite "/root/.gnome2"

        # GST_REGISTRY is to work around gst-inspect trying to read/write /root
        GST_REGISTRY="${S}/registry.xml" econf "$@" ${G2CONF} || die "configure failed"
}

# @FUNCTION: gnome2_src_compile
# @DESCRIPTION:
# Stub function for old EAPI.
gnome2_src_compile() {
        has ${EAPI:-0} 0 1 && gnome2_src_configure "$@"
        emake || die "compile failure"
}

# @FUNCTION: gnome2_src_install
# @DESCRIPTION:
# Gnome specific install. Handles typical GConf and scrollkeeper setup
# in packages.
gnome2_src_install() {
        has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}"
        # if this is not present, scrollkeeper-update may segfault and
        # create bogus directories in /var/lib/
        local sk_tmp_dir="/var/lib/scrollkeeper"
        dodir "${sk_tmp_dir}" || die "dodir failed"

        # we must delay gconf schema installation due to sandbox
        export GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL="1"

        if [[ -z "${USE_EINSTALL}" || "${USE_EINSTALL}" = "0" ]]; then
                debug-print "Installing with 'make install'"
                emake DESTDIR="${D}" "scrollkeeper_localstate_dir=${ED}${sk_tmp_dir} " "$@" install || die "install failed"
        else
                debug-print "Installing with 'einstall'"
                einstall "scrollkeeper_localstate_dir=${ED}${sk_tmp_dir} " "$@" || die "einstall failed"
        fi

        unset GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL

        # Manual document installation
        if [[ -n "${DOCS}" ]]; then
                dodoc ${DOCS} || die "dodoc failed"
        fi

        # Do not keep /var/lib/scrollkeeper because:
        # 1. The scrollkeeper database is regenerated at pkg_postinst()
        # 2. ${ED}/var/lib/scrollkeeper contains only indexes for the current pkg
        #    thus it makes no sense if pkg_postinst ISN'T run for some reason.
        if [[ -z "$(find "${D}" -name '*.omf')" ]]; then
                export SCROLLKEEPER_UPDATE="0"
        fi
        rm -rf "${ED}${sk_tmp_dir}"

        # Make sure this one doesn't get in the portage db
        rm -fr "${ED}/usr/share/applications/mimeinfo.cache"
}

# @FUNCTION: gnome2_pkg_preinst
# @DESCRIPTION:
# Finds Icons, GConf and GSettings schemas for later handling in pkg_postinst
gnome2_pkg_preinst() {
        gnome2_gconf_savelist
        gnome2_icon_savelist
        gnome2_schemas_savelist
}

# @FUNCTION: gnome2_pkg_postinst
# @DESCRIPTION:
# Handle scrollkeeper, GConf, GSettings, Icons, desktop and mime
# database updates.
gnome2_pkg_postinst() {
        gnome2_gconf_install
        fdo-mime_desktop_database_update
        fdo-mime_mime_database_update
        gnome2_icon_cache_update
        gnome2_schemas_update

        if [[ "${SCROLLKEEPER_UPDATE}" = "1" ]]; then
                gnome2_scrollkeeper_update
        fi
}

# @#FUNCTION: gnome2_pkg_prerm
# @#DESCRIPTION:
# # FIXME Handle GConf schemas removal
#gnome2_pkg_prerm() {
#       gnome2_gconf_uninstall
#}

# @FUNCTION: gnome2_pkg_postrm
# @DESCRIPTION:
# Handle scrollkeeper, GSettings, Icons, desktop and mime database updates.
gnome2_pkg_postrm() {
        fdo-mime_desktop_database_update
        fdo-mime_mime_database_update
        gnome2_icon_cache_update
        gnome2_schemas_update --uninstall

        if [[ "${SCROLLKEEPER_UPDATE}" = "1" ]]; then
                gnome2_scrollkeeper_update
        fi
}
1	eva	1.91	# Copyright 1999-2011 Gentoo Foundation
2	blocke	1.1	# Distributed under the terms of the GNU General Public License v2
3	eva	1.91	# $Header: /var/cvsroot/gentoo-x86/eclass/gnome2.eclass,v 1.90 2010/12/07 06:20:40 eva Exp $
4	leonardop	1.77
5	eva	1.91	# @ECLASS: gnome2.eclass
6			# @MAINTAINER:
7			# gnome@gentoo.org
8			# @BLURB:
9			# @DESCRIPTION:
10	leonardop	1.77	# Exports portage base functions used by ebuilds written for packages using the
11	leonardop	1.78	# GNOME framework. For additional functions, see gnome2-utils.eclass.
12	blocke	1.2
13	compnerd	1.80	inherit fdo-mime libtool gnome.org gnome2-utils
14	blocke	1.1
15	dang	1.86	case "${EAPI:-0}" in
16			0\|1)
17			EXPORT_FUNCTIONS src_unpack src_compile src_install pkg_preinst pkg_postinst pkg_postrm
18			;;
19	eva	1.90	2\|3)
20	dang	1.86	EXPORT_FUNCTIONS src_unpack src_prepare src_configure src_compile src_install pkg_preinst pkg_postinst pkg_postrm
21			;;
22	eva	1.90	*) die "EAPI=${EAPI} is not supported" ;;
23	dang	1.86	esac
24	leonardop	1.77
25	eva	1.91	# @ECLASS-VARIABLE: G2CONF
26			# @DEFAULT-UNSET
27			# @DESCRIPTION:
28	allanonjl	1.63	# Extra configure opts passed to econf
29	compnerd	1.81	G2CONF=${G2CONF:-""}
30	spider	1.19
31	eva	1.91	# @ECLASS-VARIABLE: ELTCONF
32			# @DEFAULT-UNSET
33			# @DESCRIPTION:
34	allanonjl	1.63	# Extra options passed to elibtoolize
35	compnerd	1.81	ELTCONF=${ELTCONF:-""}
36	leonardop	1.59
37	eva	1.91	# @ECLASS-VARIABLE: USE_EINSTALL
38			# @DEFAULT-UNSET
39			# @DEPRECATED
40			# @DESCRIPTION:
41	allanonjl	1.63	# Should we use EINSTALL instead of DESTDIR
42	compnerd	1.81	USE_EINSTALL=${USE_EINSTALL:-""}
43	leonardop	1.59
44	eva	1.91	# @ECLASS-VARIABLE: USE_EINSTALL
45			# @DEPRECATED
46			# @DESCRIPTION:
47			# Whether to run scrollkeeper for this package or not.
48	compnerd	1.81	SCROLLKEEPER_UPDATE=${SCROLLKEEPER_UPDATE:-"1"}
49	leonardop	1.59
50	eva	1.91	# @ECLASS-VARIABLE: DOCS
51			# @DEFAULT-UNSET
52			# @DESCRIPTION:
53			# String containing documents passed to dodoc command.
54
55			# @ECLASS-VARIABLE: GCONF_DEBUG
56			# @DEFAULT_UNSET
57			# @DESCRIPTION:
58			# Whether to handle debug or not.
59			# Some gnome applications support various levels of debugging (yes, no, minimum,
60			# etc), but using --disable-debug also removes g_assert which makes debugging
61			# harder. This variable should be set to yes for such packages for the eclass
62			# to handle it properly. It will enable minimal debug with USE=-debug.
63			# Note that this is most commonly found in configure.ac as GNOME_DEBUG_CHECK.
64	leonardop	1.59
65	foser	1.56
66	allanonjl	1.71	if [[ ${GCONF_DEBUG} != "no" ]]; then
67			IUSE="debug"
68			fi
69	blocke	1.1
70	leonardop	1.78
71	eva	1.91	# @FUNCTION: gnome2_src_unpack
72			# @DESCRIPTION:
73			# Stub function for old EAPI.
74	allanonjl	1.63	gnome2_src_unpack() {
75			unpack ${A}
76	eva	1.83	cd "${S}"
77	dang	1.86	has ${EAPI:-0} 0 1 && gnome2_src_prepare
78			}
79	foser	1.45
80	eva	1.91	# @FUNCTION: gnome2_src_prepare
81			# @DESCRIPTION:
82			# Fix build of scrollkeeper documentation and run elibtoolize.
83	dang	1.86	gnome2_src_prepare() {
84	allanonjl	1.63	# Prevent scrollkeeper access violations
85			gnome2_omf_fix
86	compnerd	1.81
87			# Run libtoolize
88			elibtoolize ${ELTCONF}
89	allanonjl	1.63	}
90	foser	1.45
91	eva	1.91	# @FUNCTION: gnome2_src_configure
92			# @DESCRIPTION:
93			# Gnome specific configure handling
94	allanonjl	1.63	gnome2_src_configure() {
95			# Update the GNOME configuration options
96	allanonjl	1.72	if [[ ${GCONF_DEBUG} != 'no' ]] ; then
97			if use debug ; then
98			G2CONF="${G2CONF} --enable-debug=yes"
99			fi
100	allanonjl	1.71	fi
101	compnerd	1.76
102			# Prevent a QA warning
103			if hasq doc ${IUSE} ; then
104			G2CONF="${G2CONF} $(use_enable doc gtk-doc)"
105			fi
106	blocke	1.1
107	leonardop	1.77	# Avoid sandbox violations caused by misbehaving packages (bug #128289)
108	dang	1.82	addwrite "/root/.gnome2"
109	allanonjl	1.70
110	allanonjl	1.63	# GST_REGISTRY is to work around gst-inspect trying to read/write /root
111			GST_REGISTRY="${S}/registry.xml" econf "$@" ${G2CONF} \|\| die "configure failed"
112	blocke	1.9	}
113
114	eva	1.91	# @FUNCTION: gnome2_src_compile
115			# @DESCRIPTION:
116			# Stub function for old EAPI.
117	blocke	1.9	gnome2_src_compile() {
118	dang	1.86	has ${EAPI:-0} 0 1 && gnome2_src_configure "$@"
119	blocke	1.1	emake \|\| die "compile failure"
120			}
121
122	eva	1.91	# @FUNCTION: gnome2_src_install
123			# @DESCRIPTION:
124			# Gnome specific install. Handles typical GConf and scrollkeeper setup
125			# in packages.
126	blocke	1.1	gnome2_src_install() {
127	abcd	1.87	has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}"
128	azarah	1.22	# if this is not present, scrollkeeper-update may segfault and
129			# create bogus directories in /var/lib/
130	leonardop	1.77	local sk_tmp_dir="/var/lib/scrollkeeper"
131	eva	1.89	dodir "${sk_tmp_dir}" \|\| die "dodir failed"
132	blocke	1.1
133	blocke	1.8	# we must delay gconf schema installation due to sandbox
134	blocke	1.3	export GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL="1"
135
136	allanonjl	1.63	if [[ -z "${USE_EINSTALL}" \|\| "${USE_EINSTALL}" = "0" ]]; then
137	leonardop	1.77	debug-print "Installing with 'make install'"
138	abcd	1.87	emake DESTDIR="${D}" "scrollkeeper_localstate_dir=${ED}${sk_tmp_dir} " "$@" install \|\| die "install failed"
139	liquidx	1.30	else
140	leonardop	1.77	debug-print "Installing with 'einstall'"
141	abcd	1.87	einstall "scrollkeeper_localstate_dir=${ED}${sk_tmp_dir} " "$@" \|\| die "einstall failed"
142	liquidx	1.30	fi
143	blocke	1.1
144	blocke	1.10	unset GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL
145
146	allanonjl	1.63	# Manual document installation
147	eva	1.89	if [[ -n "${DOCS}" ]]; then
148			dodoc ${DOCS} \|\| die "dodoc failed"
149			fi
150	liquidx	1.30
151	allanonjl	1.63	# Do not keep /var/lib/scrollkeeper because:
152	leonardop	1.77	# 1. The scrollkeeper database is regenerated at pkg_postinst()
153	abcd	1.87	# 2. ${ED}/var/lib/scrollkeeper contains only indexes for the current pkg
154	liquidx	1.30	# thus it makes no sense if pkg_postinst ISN'T run for some reason.
155	remi	1.84	if [[ -z "$(find "${D}" -name '*.omf')" ]]; then
156	liquidx	1.30	export SCROLLKEEPER_UPDATE="0"
157	blocke	1.1	fi
158	abcd	1.87	rm -rf "${ED}${sk_tmp_dir}"
159	foser	1.45
160	allanonjl	1.63	# Make sure this one doesn't get in the portage db
161	abcd	1.87	rm -fr "${ED}/usr/share/applications/mimeinfo.cache"
162	spider	1.20	}
163
164	eva	1.91	# @FUNCTION: gnome2_pkg_preinst
165			# @DESCRIPTION:
166			# Finds Icons, GConf and GSettings schemas for later handling in pkg_postinst
167	remi	1.84	gnome2_pkg_preinst() {
168			gnome2_gconf_savelist
169	remi	1.85	gnome2_icon_savelist
170	eva	1.88	gnome2_schemas_savelist
171	remi	1.84	}
172
173	eva	1.91	# @FUNCTION: gnome2_pkg_postinst
174			# @DESCRIPTION:
175			# Handle scrollkeeper, GConf, GSettings, Icons, desktop and mime
176			# database updates.
177	liquidx	1.30	gnome2_pkg_postinst() {
178			gnome2_gconf_install
179	foser	1.45	fdo-mime_desktop_database_update
180			fdo-mime_mime_database_update
181	leonardop	1.54	gnome2_icon_cache_update
182	eva	1.88	gnome2_schemas_update
183	swegener	1.79
184	leonardop	1.78	if [[ "${SCROLLKEEPER_UPDATE}" = "1" ]]; then
185			gnome2_scrollkeeper_update
186			fi
187	liquidx	1.30	}
188
189	eva	1.91	# @#FUNCTION: gnome2_pkg_prerm
190			# @#DESCRIPTION:
191			# # FIXME Handle GConf schemas removal
192	foser	1.40	#gnome2_pkg_prerm() {
193			# gnome2_gconf_uninstall
194			#}
195	foser	1.39
196	eva	1.91	# @FUNCTION: gnome2_pkg_postrm
197			# @DESCRIPTION:
198			# Handle scrollkeeper, GSettings, Icons, desktop and mime database updates.
199	liquidx	1.30	gnome2_pkg_postrm() {
200	foser	1.45	fdo-mime_desktop_database_update
201			fdo-mime_mime_database_update
202	leonardop	1.54	gnome2_icon_cache_update
203	eva	1.88	gnome2_schemas_update --uninstall
204	leonardop	1.78
205			if [[ "${SCROLLKEEPER_UPDATE}" = "1" ]]; then
206			gnome2_scrollkeeper_update
207			fi
208	liquidx	1.30	}