gentoo-x86/eclass/elisp.eclass

# Copyright 1999-2009 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.39 2009/03/26 14:14:22 ulm Exp $
#
# Copyright 2002-2003 Matthew Kennedy <mkennedy@gentoo.org>
# Copyright 2003      Jeremy Maitin-Shepard <jbms@attbi.com>
# Copyright 2007-2009 Christian Faulhammer <fauli@gentoo.org>
# Copyright 2007-2009 Ulrich Müller <ulm@gentoo.org>
#
# @ECLASS: elisp.eclass
# @MAINTAINER:
# Feel free to contact the Emacs team through <emacs@gentoo.org> if you
# have problems, suggestions or questions.
# @BLURB: Eclass for Emacs Lisp packages
# @DESCRIPTION:
#
# This eclass is designed to install elisp files of Emacs related
# packages into the site-lisp directory. The majority of elisp packages
# will only need to define the standard ebuild variables (like SRC_URI)
# and optionally SITEFILE for successful installation.
#
# Emacs support for other than pure elisp packages is handled by
# elisp-common.eclass where you won't have a dependency on Emacs itself.
# All elisp-* functions are documented there.
#
# If the package's source is a single (in whatever way) compressed elisp
# file with the file name ${P}.el, then this eclass will move ${P}.el to
# ${PN}.el in src_unpack().

# @ECLASS-VARIABLE: NEED_EMACS
# @DESCRIPTION:
# If you need anything different from Emacs 21, use the NEED_EMACS
# variable before inheriting elisp.eclass.  Set it to the major version
# your package uses and the dependency will be adjusted.

# @ECLASS-VARIABLE: DOCS
# @DESCRIPTION:
# DOCS="blah.txt ChangeLog" is automatically used to install the given
# files by dodoc in src_install().

# @ECLASS-VARIABLE: ELISP_PATCHES
# @DESCRIPTION:
# Any patches to apply after unpacking the sources. Patches are searched
# both in ${PWD} and ${FILESDIR}.

# @ECLASS-VARIABLE: SITEFILE
# @DESCRIPTION:
# Name of package's site-init file.  The filename must match the shell
# pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
# reserved for internal use.  "50${PN}-gentoo.el" is a reasonable choice
# in most cases.

inherit elisp-common eutils versionator

case "${EAPI:-0}" in
        0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \
                pkg_{setup,postinst,postrm} ;;
        *) EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
                pkg_{setup,postinst,postrm} ;;
esac

DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
RDEPEND="${DEPEND}"
IUSE=""

elisp_pkg_setup() {
        local need_emacs=${NEED_EMACS:-21}
        local have_emacs=$(elisp-emacs-version)
        if ! version_is_at_least "${need_emacs}" "${have_emacs}"; then
                eerror "This package needs at least Emacs ${need_emacs}."
                eerror "Use \"eselect emacs\" to select the active version."
                die "Emacs version ${have_emacs} is too low."
        fi
        einfo "Emacs version: ${have_emacs}"
}

elisp_src_unpack() {
        [ -n "${A}" ] && unpack ${A}
        if [ -f ${P}.el ]; then
                # the "simple elisp" case with a single *.el file in WORKDIR
                mv ${P}.el ${PN}.el || die
                [ -d "${S}" ] || S=${WORKDIR}
        fi

        case "${EAPI:-0}" in
                0|1) elisp_src_prepare ;;
        esac
}

elisp_src_prepare() {
        local patch
        for patch in ${ELISP_PATCHES}; do
                if [ -f "${patch}" ]; then
                        epatch "${patch}"
                elif [ -f "${FILESDIR}/${patch}" ]; then
                        epatch "${FILESDIR}/${patch}"
                else
                        die "Cannot find ${patch}"
                fi
        done
}

elisp_src_configure() { :; }

elisp_src_compile() {
        elisp-compile *.el || die
}

elisp_src_install() {
        elisp-install ${PN} *.el *.elc || die
        if [ -n "${SITEFILE}" ]; then
                elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
        fi
        if [ -n "${DOCS}" ]; then
                dodoc ${DOCS} || die
        fi
}

elisp_pkg_postinst() {
        elisp-site-regen
}

elisp_pkg_postrm() {
        elisp-site-regen
}
1	ulm	1.38	# Copyright 1999-2009 Gentoo Foundation
2	mkennedy	1.1	# Distributed under the terms of the GNU General Public License v2
3	ulm	1.40	# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.39 2009/03/26 14:14:22 ulm Exp $
4	vapier	1.4	#
5	ulm	1.20	# Copyright 2002-2003 Matthew Kennedy <mkennedy@gentoo.org>
6	ulm	1.29	# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
7	ulm	1.38	# Copyright 2007-2009 Christian Faulhammer <fauli@gentoo.org>
8			# Copyright 2007-2009 Ulrich Müller <ulm@gentoo.org>
9	vapier	1.4	#
10	ulm	1.21	# @ECLASS: elisp.eclass
11			# @MAINTAINER:
12	ulm	1.24	# Feel free to contact the Emacs team through <emacs@gentoo.org> if you
13			# have problems, suggestions or questions.
14	ulm	1.21	# @BLURB: Eclass for Emacs Lisp packages
15			# @DESCRIPTION:
16			#
17	ulm	1.38	# This eclass is designed to install elisp files of Emacs related
18			# packages into the site-lisp directory. The majority of elisp packages
19			# will only need to define the standard ebuild variables (like SRC_URI)
20			# and optionally SITEFILE for successful installation.
21	opfer	1.17	#
22	opfer	1.18	# Emacs support for other than pure elisp packages is handled by
23	ulm	1.20	# elisp-common.eclass where you won't have a dependency on Emacs itself.
24			# All elisp-* functions are documented there.
25	ulm	1.30	#
26			# If the package's source is a single (in whatever way) compressed elisp
27			# file with the file name ${P}.el, then this eclass will move ${P}.el to
28			# ${PN}.el in src_unpack().
29	ulm	1.23
30	ulm	1.38	# @ECLASS-VARIABLE: NEED_EMACS
31	ulm	1.35	# @DESCRIPTION:
32	ulm	1.38	# If you need anything different from Emacs 21, use the NEED_EMACS
33			# variable before inheriting elisp.eclass. Set it to the major version
34			# your package uses and the dependency will be adjusted.
35	ulm	1.35
36	ulm	1.23	# @ECLASS-VARIABLE: DOCS
37			# @DESCRIPTION:
38	opfer	1.19	# DOCS="blah.txt ChangeLog" is automatically used to install the given
39			# files by dodoc in src_install().
40	ulm	1.23
41	ulm	1.40	# @ECLASS-VARIABLE: ELISP_PATCHES
42			# @DESCRIPTION:
43			# Any patches to apply after unpacking the sources. Patches are searched
44			# both in ${PWD} and ${FILESDIR}.
45
46	ulm	1.38	# @ECLASS-VARIABLE: SITEFILE
47	ulm	1.23	# @DESCRIPTION:
48	ulm	1.38	# Name of package's site-init file. The filename must match the shell
49			# pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
50			# reserved for internal use. "50${PN}-gentoo.el" is a reasonable choice
51			# in most cases.
52	opfer	1.19
53	ulm	1.40	inherit elisp-common eutils versionator
54	opfer	1.19
55	ulm	1.40	case "${EAPI:-0}" in
56			0\|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \
57			pkg_{setup,postinst,postrm} ;;
58			*) EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
59			pkg_{setup,postinst,postrm} ;;
60			esac
61	ulm	1.38
62	ulm	1.33	DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
63	ulm	1.40	RDEPEND="${DEPEND}"
64	opfer	1.19	IUSE=""
65	opfer	1.18
66	opfer	1.19	elisp_pkg_setup() {
67	ulm	1.33	local need_emacs=${NEED_EMACS:-21}
68			local have_emacs=$(elisp-emacs-version)
69			if ! version_is_at_least "${need_emacs}" "${have_emacs}"; then
70			eerror "This package needs at least Emacs ${need_emacs}."
71	opfer	1.19	eerror "Use \"eselect emacs\" to select the active version."
72	ulm	1.33	die "Emacs version ${have_emacs} is too low."
73	opfer	1.19	fi
74	ulm	1.36	einfo "Emacs version: ${have_emacs}"
75	opfer	1.19	}
76	mkennedy	1.1
77	opfer	1.18	elisp_src_unpack() {
78	ulm	1.33	[ -n "${A}" ] && unpack ${A}
79	ulm	1.30	if [ -f ${P}.el ]; then
80	ulm	1.39	# the "simple elisp" case with a single *.el file in WORKDIR
81	fauli	1.37	mv ${P}.el ${PN}.el \|\| die
82	ulm	1.39	[ -d "${S}" ] \|\| S=${WORKDIR}
83	opfer	1.18	fi
84	ulm	1.40
85			case "${EAPI:-0}" in
86			0\|1) elisp_src_prepare ;;
87			esac
88			}
89
90			elisp_src_prepare() {
91			local patch
92			for patch in ${ELISP_PATCHES}; do
93			if [ -f "${patch}" ]; then
94			epatch "${patch}"
95			elif [ -f "${FILESDIR}/${patch}" ]; then
96			epatch "${FILESDIR}/${patch}"
97			else
98			die "Cannot find ${patch}"
99			fi
100			done
101	mkennedy	1.5	}
102
103	ulm	1.40	elisp_src_configure() { :; }
104
105	opfer	1.18	elisp_src_compile() {
106	ulm	1.35	elisp-compile *.el \|\| die
107	mkennedy	1.5	}
108
109	opfer	1.18	elisp_src_install() {
110	ulm	1.35	elisp-install ${PN} .el .elc \|\| die
111			if [ -n "${SITEFILE}" ]; then
112			elisp-site-file-install "${FILESDIR}/${SITEFILE}" \|\| die
113			fi
114	opfer	1.19	if [ -n "${DOCS}" ]; then
115	fauli	1.37	dodoc ${DOCS} \|\| die
116	opfer	1.19	fi
117	mkennedy	1.5	}
118
119	opfer	1.18	elisp_pkg_postinst() {
120			elisp-site-regen
121	mkennedy	1.5	}
122
123	opfer	1.18	elisp_pkg_postrm() {
124			elisp-site-regen
125	mkennedy	1.5	}