eclass/gnome2.eclass

   1 # Copyright 1999-2015 Gentoo Foundation
   2 # Distributed under the terms of the GNU General Public License v2
   3 # $Id$
   4
   5 # @ECLASS: gnome2.eclass
   6 # @MAINTAINER:
   7 # gnome@gentoo.org
   8 # @BLURB: Provides phases for Gnome/Gtk+ based packages.
   9 # @DESCRIPTION:
  10 # Exports portage base functions used by ebuilds written for packages using the
  11 # GNOME framework. For additional functions, see gnome2-utils.eclass.
  12
  13 inherit eutils libtool gnome.org gnome2-utils xdg
  14
  15 case "${EAPI:-0}" in
  16         4|5)
  17                 EXPORT_FUNCTIONS src_unpack src_prepare src_configure src_compile src_install pkg_preinst pkg_postinst pkg_postrm
  18                 ;;
  19         *) die "EAPI=${EAPI} is not supported" ;;
  20 esac
  21
  22 # @ECLASS-VARIABLE: G2CONF
  23 # @DEFAULT_UNSET
  24 # @DESCRIPTION:
  25 # Extra configure opts passed to econf.
  26 # Deprecated, pass extra arguments to gnome2_src_configure.
  27 G2CONF=${G2CONF:-""}
  28
  29 # @ECLASS-VARIABLE: GNOME2_LA_PUNT
  30 # @DESCRIPTION:
  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"}
  35 else
  36         GNOME2_LA_PUNT=${GNOME2_LA_PUNT:-""}
  37 fi
  38
  39 # @ECLASS-VARIABLE: ELTCONF
  40 # @DEFAULT_UNSET
  41 # @DESCRIPTION:
  42 # Extra options passed to elibtoolize
  43 ELTCONF=${ELTCONF:-""}
  44
  45 # @ECLASS-VARIABLE: DOCS
  46 # @DEFAULT_UNSET
  47 # @DESCRIPTION:
  48 # String containing documents passed to dodoc command.
  49
  50 # @ECLASS-VARIABLE: GCONF_DEBUG
  51 # @DEFAULT_UNSET
  52 # @DESCRIPTION:
  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.
  59
  60
  61 if [[ ${GCONF_DEBUG} != "no" ]]; then
  62         IUSE="debug"
  63 fi
  64
  65 # @FUNCTION: gnome2_src_unpack
  66 # @DESCRIPTION:
  67 # Stub function for old EAPI.
  68 gnome2_src_unpack() {
  69         unpack ${A}
  70         cd "${S}"
  71 }
  72
  73 # @FUNCTION: gnome2_src_prepare
  74 # @DESCRIPTION:
  75 # Prepare environment for build, fix build of scrollkeeper documentation,
  76 # run elibtoolize.
  77 gnome2_src_prepare() {
  78         xdg_src_prepare
  79
  80         # Prevent assorted access violations and test failures
  81         gnome2_environment_reset
  82
  83         # Prevent scrollkeeper access violations
  84         gnome2_omf_fix
  85
  86         # Disable all deprecation warnings
  87         gnome2_disable_deprecation_warning
  88
  89         # Run libtoolize
  90         elibtoolize ${ELTCONF}
  91 }
  92
  93 # @FUNCTION: gnome2_src_configure
  94 # @DESCRIPTION:
  95 # Gnome specific configure handling
  96 gnome2_src_configure() {
  97         # Deprecated for a long time now, see Gnome team policies
  98         if [[ -n ${G2CONF} ]] ; then
  99                 eqawarn "G2CONF set, please review documentation at https://wiki.gentoo.org/wiki/Project:GNOME/Gnome_Team_Ebuild_Policies#G2CONF_and_src_configure"
 100         fi
 101
 102         local g2conf=()
 103
 104         # Update the GNOME configuration options
 105         if [[ ${GCONF_DEBUG} != 'no' ]] ; then
 106                 if use debug ; then
 107                         g2conf+=( --enable-debug=yes )
 108                 fi
 109         fi
 110
 111         # Starting with EAPI=5, we consider packages installing gtk-doc to be
 112         # handled by adding DEPEND="dev-util/gtk-doc-am" which provides tools to
 113         # relink URLs in documentation to already installed documentation.
 114         # This decision also greatly helps with constantly broken doc generation.
 115         # Remember to drop 'doc' USE flag from your package if it was only used to
 116         # rebuild docs.
 117         # Preserve old behavior for older EAPI.
 118         if grep -q "enable-gtk-doc" "${ECONF_SOURCE:-.}"/configure ; then
 119                 if has ${EAPI:-0} 4 && in_iuse doc ; then
 120                         g2conf+=( $(use_enable doc gtk-doc) )
 121                 else
 122                         g2conf+=( --disable-gtk-doc )
 123                 fi
 124         fi
 125
 126         # Pass --disable-maintainer-mode when needed
 127         if grep -q "^[[:space:]]*AM_MAINTAINER_MODE(\[enable\])" \
 128                 "${ECONF_SOURCE:-.}"/configure.*; then
 129                 g2conf+=( --disable-maintainer-mode )
 130         fi
 131
 132         # Pass --disable-scrollkeeper when possible
 133         if grep -q "disable-scrollkeeper" "${ECONF_SOURCE:-.}"/configure; then
 134                 g2conf+=( --disable-scrollkeeper )
 135         fi
 136
 137         # Pass --disable-silent-rules when possible (not needed for eapi5), bug #429308
 138         if has ${EAPI:-0} 4; then
 139                 if grep -q "disable-silent-rules" "${ECONF_SOURCE:-.}"/configure; then
 140                         g2conf+=( --disable-silent-rules )
 141                 fi
 142         fi
 143
 144         # Pass --disable-schemas-install when possible
 145         if grep -q "disable-schemas-install" "${ECONF_SOURCE:-.}"/configure; then
 146                 g2conf+=( --disable-schemas-install )
 147         fi
 148
 149         # Pass --disable-schemas-compile when possible
 150         if grep -q "disable-schemas-compile" "${ECONF_SOURCE:-.}"/configure; then
 151                 g2conf+=( --disable-schemas-compile )
 152         fi
 153
 154         # Pass --enable-compile-warnings=minimum as we don't want -Werror* flags, bug #471336
 155         if grep -q "enable-compile-warnings" "${ECONF_SOURCE:-.}"/configure; then
 156                 g2conf+=( --enable-compile-warnings=minimum )
 157         fi
 158
 159         # Pass --docdir with proper directory, bug #482646
 160         if grep -q "^ *--docdir=" "${ECONF_SOURCE:-.}"/configure; then
 161                 g2conf+=( --docdir="${EPREFIX}"/usr/share/doc/${PF} )
 162         fi
 163
 164         # Avoid sandbox violations caused by gnome-vfs (bug #128289 and #345659)
 165         addwrite "$(unset HOME; echo ~)/.gnome2"
 166
 167         econf ${g2conf[@]} ${G2CONF} "$@"
 168 }
 169
 170 # @FUNCTION: gnome2_src_compile
 171 # @DESCRIPTION:
 172 # Only default src_compile for now
 173 gnome2_src_compile() {
 174         emake
 175 }
 176
 177 # @FUNCTION: gnome2_src_install
 178 # @DESCRIPTION:
 179 # Gnome specific install. Handles typical GConf and scrollkeeper setup
 180 # in packages and removal of .la files if requested
 181 gnome2_src_install() {
 182         # if this is not present, scrollkeeper-update may segfault and
 183         # create bogus directories in /var/lib/
 184         local sk_tmp_dir="/var/lib/scrollkeeper"
 185         dodir "${sk_tmp_dir}" || die "dodir failed"
 186
 187         # we must delay gconf schema installation due to sandbox
 188         export GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL="1"
 189
 190         debug-print "Installing with 'make install'"
 191         emake DESTDIR="${D}" "scrollkeeper_localstate_dir=${ED}${sk_tmp_dir} " "$@" install || die "install failed"
 192
 193         unset GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL
 194
 195         # Handle documentation as 'default' for eapi5 and newer, bug #373131
 196         if has ${EAPI:-0} 4; then
 197                 # Manual document installation
 198                 if [[ -n "${DOCS}" ]]; then
 199                         dodoc ${DOCS} || die "dodoc failed"
 200                 fi
 201         else
 202                 einstalldocs
 203         fi
 204
 205         # Do not keep /var/lib/scrollkeeper because:
 206         # 1. The scrollkeeper database is regenerated at pkg_postinst()
 207         # 2. ${ED}/var/lib/scrollkeeper contains only indexes for the current pkg
 208         #    thus it makes no sense if pkg_postinst ISN'T run for some reason.
 209         rm -rf "${ED}${sk_tmp_dir}"
 210         rmdir "${ED}/var/lib" 2>/dev/null
 211         rmdir "${ED}/var" 2>/dev/null
 212
 213         # Make sure this one doesn't get in the portage db
 214         rm -fr "${ED}/usr/share/applications/mimeinfo.cache"
 215
 216         # Delete all .la files
 217         if has ${EAPI:-0} 4; then
 218                 if [[ "${GNOME2_LA_PUNT}" != "no" ]]; then
 219                         ebegin "Removing .la files"
 220                         if ! use_if_iuse static-libs ; then
 221                                 find "${D}" -name '*.la' -exec rm -f {} + || die "la file removal failed"
 222                         fi
 223                         eend
 224                 fi
 225         else
 226                 case "${GNOME2_LA_PUNT}" in
 227                         yes)    prune_libtool_files --modules;;
 228                         no)     ;;
 229                         *)      prune_libtool_files;;
 230                 esac
 231         fi
 232 }
 233
 234 # @FUNCTION: gnome2_pkg_preinst
 235 # @DESCRIPTION:
 236 # Finds Icons, GConf and GSettings schemas for later handling in pkg_postinst
 237 gnome2_pkg_preinst() {
 238         xdg_pkg_preinst
 239         gnome2_gconf_savelist
 240         gnome2_icon_savelist
 241         gnome2_schemas_savelist
 242         gnome2_scrollkeeper_savelist
 243         gnome2_gdk_pixbuf_savelist
 244 }
 245
 246 # @FUNCTION: gnome2_pkg_postinst
 247 # @DESCRIPTION:
 248 # Handle scrollkeeper, GConf, GSettings, Icons, desktop and mime
 249 # database updates.
 250 gnome2_pkg_postinst() {
 251         xdg_pkg_postinst
 252         gnome2_gconf_install
 253         gnome2_icon_cache_update
 254         gnome2_schemas_update
 255         gnome2_scrollkeeper_update
 256         gnome2_gdk_pixbuf_update
 257 }
 258
 259 # # FIXME Handle GConf schemas removal
 260 #gnome2_pkg_prerm() {
 261 #       gnome2_gconf_uninstall
 262 #}
 263
 264 # @FUNCTION: gnome2_pkg_postrm
 265 # @DESCRIPTION:
 266 # Handle scrollkeeper, GSettings, Icons, desktop and mime database updates.
 267 gnome2_pkg_postrm() {
 268         xdg_pkg_postrm
 269         gnome2_icon_cache_update
 270         gnome2_schemas_update
 271         gnome2_scrollkeeper_update
 272 }