gentoo-x86/eclass/gnome2.eclass

# Copyright 1999-2012 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/gnome2.eclass,v 1.104 2011/12/14 19:47:54 tetromino 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|4)
                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: GNOME2_LA_PUNT
# @DESCRIPTION:
# Should we delete all the .la files?
# NOT to be used without due consideration.
GNOME2_LA_PUNT=${GNOME2_LA_PUNT:-"no"}

# @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: SCROLLKEEPER_UPDATE
# @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:
# Prepare environment for build, fix build of scrollkeeper documentation,
# run elibtoolize.
gnome2_src_prepare() {
        # Prevent assorted access violations and test failures
        gnome2_environment_reset

        # Prevent scrollkeeper access violations
        gnome2_omf_fix

        # Run libtoolize
        if has ${EAPI:-0} 0 1 2 3; then
                elibtoolize ${ELTCONF}
        else
                # Everything is fatal EAPI 4 onwards
                nonfatal elibtoolize ${ELTCONF}
        fi

}

# @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 has doc ${IUSE} ; then
                G2CONF="${G2CONF} $(use_enable doc gtk-doc)"
        fi

        # Pass --disable-maintainer-mode when needed
        if grep -q "^[[:space:]]*AM_MAINTAINER_MODE(\[enable\])" configure.*; then
                G2CONF="${G2CONF} --disable-maintainer-mode"
        fi

        # Pass --disable-scrollkeeper when possible
        if grep -q "disable-scrollkeeper" configure; then
                G2CONF="${G2CONF} --disable-scrollkeeper"
        fi

        # Avoid sandbox violations caused by gnome-vfs (bug #128289 and #345659)
        addwrite "$(unset HOME; echo ~)/.gnome2"

        econf "$@" ${G2CONF}
}

# @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 and removal of .la files if requested
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.
        rm -rf "${ED}${sk_tmp_dir}"
        rmdir "${ED}/var/lib" 2>/dev/null
        rmdir "${ED}/var" 2>/dev/null

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

        # Delete all .la files
        if [[ "${GNOME2_LA_PUNT}" != "no" ]]; then
                ebegin "Removing .la files"
                if ! { has static-libs ${IUSE//+} && use static-libs; }; then
                        find "${D}" -name '*.la' -exec rm -f {} + || die "la file removal failed"
                fi
                eend
        fi
}

# @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
        gnome2_scrollkeeper_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
        gnome2_scrollkeeper_update
}

# @#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
        gnome2_scrollkeeper_update
}
1	eva	1.105	# Copyright 1999-2012 Gentoo Foundation
2	blocke	1.1	# Distributed under the terms of the GNU General Public License v2
3	eva	1.105	# $Header: /var/cvsroot/gentoo-x86/eclass/gnome2.eclass,v 1.104 2011/12/14 19:47:54 tetromino 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.94	2\|3\|4)
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.95	# @ECLASS-VARIABLE: GNOME2_LA_PUNT
32			# @DESCRIPTION:
33			# Should we delete all the .la files?
34			# NOT to be used without due consideration.
35			GNOME2_LA_PUNT=${GNOME2_LA_PUNT:-"no"}
36
37	eva	1.91	# @ECLASS-VARIABLE: ELTCONF
38			# @DEFAULT-UNSET
39			# @DESCRIPTION:
40	allanonjl	1.63	# Extra options passed to elibtoolize
41	compnerd	1.81	ELTCONF=${ELTCONF:-""}
42	leonardop	1.59
43	eva	1.91	# @ECLASS-VARIABLE: USE_EINSTALL
44			# @DEFAULT-UNSET
45			# @DEPRECATED
46			# @DESCRIPTION:
47	allanonjl	1.63	# Should we use EINSTALL instead of DESTDIR
48	compnerd	1.81	USE_EINSTALL=${USE_EINSTALL:-""}
49	leonardop	1.59
50	eva	1.93	# @ECLASS-VARIABLE: SCROLLKEEPER_UPDATE
51	eva	1.91	# @DEPRECATED
52			# @DESCRIPTION:
53			# Whether to run scrollkeeper for this package or not.
54	compnerd	1.81	SCROLLKEEPER_UPDATE=${SCROLLKEEPER_UPDATE:-"1"}
55	leonardop	1.59
56	eva	1.91	# @ECLASS-VARIABLE: DOCS
57			# @DEFAULT-UNSET
58			# @DESCRIPTION:
59			# String containing documents passed to dodoc command.
60
61			# @ECLASS-VARIABLE: GCONF_DEBUG
62			# @DEFAULT_UNSET
63			# @DESCRIPTION:
64			# Whether to handle debug or not.
65			# Some gnome applications support various levels of debugging (yes, no, minimum,
66			# etc), but using --disable-debug also removes g_assert which makes debugging
67			# harder. This variable should be set to yes for such packages for the eclass
68			# to handle it properly. It will enable minimal debug with USE=-debug.
69			# Note that this is most commonly found in configure.ac as GNOME_DEBUG_CHECK.
70	leonardop	1.59
71	foser	1.56
72	allanonjl	1.71	if [[ ${GCONF_DEBUG} != "no" ]]; then
73			IUSE="debug"
74			fi
75	blocke	1.1
76	leonardop	1.78
77	eva	1.91	# @FUNCTION: gnome2_src_unpack
78			# @DESCRIPTION:
79			# Stub function for old EAPI.
80	allanonjl	1.63	gnome2_src_unpack() {
81			unpack ${A}
82	eva	1.83	cd "${S}"
83	dang	1.86	has ${EAPI:-0} 0 1 && gnome2_src_prepare
84			}
85	foser	1.45
86	eva	1.91	# @FUNCTION: gnome2_src_prepare
87			# @DESCRIPTION:
88	ford_prefect	1.100	# Prepare environment for build, fix build of scrollkeeper documentation,
89			# run elibtoolize.
90	dang	1.86	gnome2_src_prepare() {
91	tetromino	1.103	# Prevent assorted access violations and test failures
92			gnome2_environment_reset
93	ford_prefect	1.100
94	allanonjl	1.63	# Prevent scrollkeeper access violations
95			gnome2_omf_fix
96	compnerd	1.81
97			# Run libtoolize
98	eva	1.94	if has ${EAPI:-0} 0 1 2 3; then
99			elibtoolize ${ELTCONF}
100			else
101			# Everything is fatal EAPI 4 onwards
102			nonfatal elibtoolize ${ELTCONF}
103			fi
104
105	allanonjl	1.63	}
106	foser	1.45
107	eva	1.91	# @FUNCTION: gnome2_src_configure
108			# @DESCRIPTION:
109			# Gnome specific configure handling
110	allanonjl	1.63	gnome2_src_configure() {
111			# Update the GNOME configuration options
112	allanonjl	1.72	if [[ ${GCONF_DEBUG} != 'no' ]] ; then
113			if use debug ; then
114			G2CONF="${G2CONF} --enable-debug=yes"
115			fi
116	allanonjl	1.71	fi
117	compnerd	1.76
118			# Prevent a QA warning
119	ssuominen	1.97	if has doc ${IUSE} ; then
120	compnerd	1.76	G2CONF="${G2CONF} $(use_enable doc gtk-doc)"
121			fi
122	blocke	1.1
123	pacho	1.102	# Pass --disable-maintainer-mode when needed
124			if grep -q "^[[:space:]]AM_MAINTAINER_MODE(\[enable\])" configure.; then
125			G2CONF="${G2CONF} --disable-maintainer-mode"
126			fi
127
128	eva	1.105	# Pass --disable-scrollkeeper when possible
129			if grep -q "disable-scrollkeeper" configure; then
130			G2CONF="${G2CONF} --disable-scrollkeeper"
131			fi
132
133	zmedico	1.98	# Avoid sandbox violations caused by gnome-vfs (bug #128289 and #345659)
134			addwrite "$(unset HOME; echo ~)/.gnome2"
135	allanonjl	1.70
136	ford_prefect	1.100	econf "$@" ${G2CONF}
137	blocke	1.9	}
138
139	eva	1.91	# @FUNCTION: gnome2_src_compile
140			# @DESCRIPTION:
141			# Stub function for old EAPI.
142	blocke	1.9	gnome2_src_compile() {
143	dang	1.86	has ${EAPI:-0} 0 1 && gnome2_src_configure "$@"
144	blocke	1.1	emake \|\| die "compile failure"
145			}
146
147	eva	1.91	# @FUNCTION: gnome2_src_install
148			# @DESCRIPTION:
149			# Gnome specific install. Handles typical GConf and scrollkeeper setup
150	eva	1.95	# in packages and removal of .la files if requested
151	blocke	1.1	gnome2_src_install() {
152	abcd	1.87	has ${EAPI:-0} 0 1 2 && ! use prefix && ED="${D}"
153	azarah	1.22	# if this is not present, scrollkeeper-update may segfault and
154			# create bogus directories in /var/lib/
155	leonardop	1.77	local sk_tmp_dir="/var/lib/scrollkeeper"
156	eva	1.89	dodir "${sk_tmp_dir}" \|\| die "dodir failed"
157	blocke	1.1
158	blocke	1.8	# we must delay gconf schema installation due to sandbox
159	blocke	1.3	export GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL="1"
160
161	allanonjl	1.63	if [[ -z "${USE_EINSTALL}" \|\| "${USE_EINSTALL}" = "0" ]]; then
162	leonardop	1.77	debug-print "Installing with 'make install'"
163	abcd	1.87	emake DESTDIR="${D}" "scrollkeeper_localstate_dir=${ED}${sk_tmp_dir} " "$@" install \|\| die "install failed"
164	liquidx	1.30	else
165	leonardop	1.77	debug-print "Installing with 'einstall'"
166	abcd	1.87	einstall "scrollkeeper_localstate_dir=${ED}${sk_tmp_dir} " "$@" \|\| die "einstall failed"
167	liquidx	1.30	fi
168	blocke	1.1
169	blocke	1.10	unset GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL
170
171	allanonjl	1.63	# Manual document installation
172	eva	1.89	if [[ -n "${DOCS}" ]]; then
173			dodoc ${DOCS} \|\| die "dodoc failed"
174			fi
175	liquidx	1.30
176	allanonjl	1.63	# Do not keep /var/lib/scrollkeeper because:
177	leonardop	1.77	# 1. The scrollkeeper database is regenerated at pkg_postinst()
178	abcd	1.87	# 2. ${ED}/var/lib/scrollkeeper contains only indexes for the current pkg
179	liquidx	1.30	# thus it makes no sense if pkg_postinst ISN'T run for some reason.
180	abcd	1.87	rm -rf "${ED}${sk_tmp_dir}"
181	eva	1.105	rmdir "${ED}/var/lib" 2>/dev/null
182			rmdir "${ED}/var" 2>/dev/null
183	foser	1.45
184	allanonjl	1.63	# Make sure this one doesn't get in the portage db
185	abcd	1.87	rm -fr "${ED}/usr/share/applications/mimeinfo.cache"
186	eva	1.95
187			# Delete all .la files
188			if [[ "${GNOME2_LA_PUNT}" != "no" ]]; then
189			ebegin "Removing .la files"
190	nirbheek	1.99	if ! { has static-libs ${IUSE//+} && use static-libs; }; then
191			find "${D}" -name '*.la' -exec rm -f {} + \|\| die "la file removal failed"
192			fi
193	eva	1.95	eend
194			fi
195	spider	1.20	}
196
197	eva	1.91	# @FUNCTION: gnome2_pkg_preinst
198			# @DESCRIPTION:
199			# Finds Icons, GConf and GSettings schemas for later handling in pkg_postinst
200	remi	1.84	gnome2_pkg_preinst() {
201			gnome2_gconf_savelist
202	remi	1.85	gnome2_icon_savelist
203	eva	1.88	gnome2_schemas_savelist
204	eva	1.105	gnome2_scrollkeeper_savelist
205	remi	1.84	}
206
207	eva	1.91	# @FUNCTION: gnome2_pkg_postinst
208			# @DESCRIPTION:
209			# Handle scrollkeeper, GConf, GSettings, Icons, desktop and mime
210			# database updates.
211	liquidx	1.30	gnome2_pkg_postinst() {
212			gnome2_gconf_install
213	foser	1.45	fdo-mime_desktop_database_update
214			fdo-mime_mime_database_update
215	leonardop	1.54	gnome2_icon_cache_update
216	eva	1.88	gnome2_schemas_update
217	eva	1.105	gnome2_scrollkeeper_update
218	liquidx	1.30	}
219
220	eva	1.91	# @#FUNCTION: gnome2_pkg_prerm
221			# @#DESCRIPTION:
222			# # FIXME Handle GConf schemas removal
223	foser	1.40	#gnome2_pkg_prerm() {
224			# gnome2_gconf_uninstall
225			#}
226	foser	1.39
227	eva	1.91	# @FUNCTION: gnome2_pkg_postrm
228			# @DESCRIPTION:
229			# Handle scrollkeeper, GSettings, Icons, desktop and mime database updates.
230	liquidx	1.30	gnome2_pkg_postrm() {
231	foser	1.45	fdo-mime_desktop_database_update
232			fdo-mime_mime_database_update
233	leonardop	1.54	gnome2_icon_cache_update
234	tetromino	1.104	gnome2_schemas_update
235	eva	1.105	gnome2_scrollkeeper_update
236	liquidx	1.30	}