1 # Copyright 1999-2019 Gentoo Authors
2 # Distributed under the terms of the GNU General Public License v2
4 # @ECLASS: elisp.eclass
6 # Gentoo GNU Emacs project <gnu-emacs@gentoo.org>
8 # Matthew Kennedy <mkennedy@gentoo.org>
9 # Jeremy Maitin-Shepard <jbms@attbi.com>
10 # Christian Faulhammer <fauli@gentoo.org>
11 # Ulrich Müller <ulm@gentoo.org>
12 # @SUPPORTED_EAPIS: 4 5 6 7
13 # @BLURB: Eclass for Emacs Lisp packages
16 # This eclass is designed to install elisp files of Emacs related
17 # packages into the site-lisp directory. The majority of elisp packages
18 # will only need to define the standard ebuild variables (like SRC_URI)
19 # and optionally SITEFILE for successful installation.
21 # Emacs support for other than pure elisp packages is handled by
22 # elisp-common.eclass where you won't have a dependency on Emacs itself.
23 # All elisp-* functions are documented there.
25 # If the package's source is a single (in whatever way) compressed elisp
26 # file with the file name ${P}.el, then this eclass will move ${P}.el to
27 # ${PN}.el in src_unpack().
29 # @ECLASS-VARIABLE: NEED_EMACS
32 # If you need anything different from Emacs 23, 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.
36 # @ECLASS-VARIABLE: ELISP_PATCHES
39 # Space separated list of patches to apply after unpacking the sources.
40 # Patch files are searched for in the current working dir, WORKDIR, and
41 # FILESDIR. This variable is semi-deprecated, preferably use the
42 # PATCHES array instead if the EAPI supports it.
44 # @ECLASS-VARIABLE: ELISP_REMOVE
47 # Space separated list of files to remove after unpacking the sources.
49 # @ECLASS-VARIABLE: SITEFILE
52 # Name of package's site-init file. The filename must match the shell
53 # pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
54 # reserved for internal use. "50${PN}-gentoo.el" is a reasonable choice
57 # @ECLASS-VARIABLE: ELISP_TEXINFO
60 # Space separated list of Texinfo sources. Respective GNU Info files
61 # will be generated in src_compile() and installed in src_install().
65 4|5) inherit epatch ;;
67 *) die "${ECLASS}: EAPI ${EAPI:-0} not supported" ;;
70 EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
71 pkg_{setup,postinst,postrm}
73 RDEPEND=">=virtual/emacs-${NEED_EMACS:-23}"
75 4|5|6) DEPEND="${RDEPEND}" ;;
76 *) BDEPEND="${RDEPEND}" ;;
79 # @FUNCTION: elisp_pkg_setup
81 # Test if the eselected Emacs version is sufficient to fulfil the major
82 # version requirement of the NEED_EMACS variable.
85 elisp-need-emacs "${NEED_EMACS:-23}"
88 1) die "Emacs version too low" ;;
89 *) die "Could not determine Emacs version" ;;
93 # @FUNCTION: elisp_src_unpack
95 # Unpack the sources; also handle the case of a single *.el file in
96 # WORKDIR for packages distributed that way.
100 if [[ -f ${P}.el ]]; then
101 # the "simple elisp" case with a single *.el file in WORKDIR
102 mv ${P}.el ${PN}.el || die
103 [[ -d ${S} ]] || S=${WORKDIR}
107 # @FUNCTION: elisp_src_prepare
109 # Apply any patches listed in ELISP_PATCHES. Patch files are searched
110 # for in the current working dir, WORKDIR, and FILESDIR.
112 elisp_src_prepare() {
114 for patch in ${ELISP_PATCHES}; do
115 if [[ -f ${patch} ]]; then
117 elif [[ -f ${WORKDIR}/${patch} ]]; then
118 file="${WORKDIR}/${patch}"
119 elif [[ -f ${FILESDIR}/${patch} ]]; then
120 file="${FILESDIR}/${patch}"
122 die "Cannot find ${patch}"
125 4|5) epatch "${file}" ;;
126 *) eapply "${file}" ;;
130 # apply PATCHES (if supported in EAPI), and any user patches
136 if [[ -n ${ELISP_REMOVE} ]]; then
137 rm ${ELISP_REMOVE} || die
141 # @FUNCTION: elisp_src_configure
143 # Do nothing, because Emacs packages seldomly bring a full build system.
145 elisp_src_configure() { :; }
147 # @FUNCTION: elisp_src_compile
149 # Call elisp-compile to byte-compile all Emacs Lisp (*.el) files.
150 # If ELISP_TEXINFO lists any Texinfo sources, call makeinfo to generate
151 # GNU Info files from them.
153 elisp_src_compile() {
155 if [[ -n ${ELISP_TEXINFO} ]]; then
156 makeinfo ${ELISP_TEXINFO} || die
160 # @FUNCTION: elisp_src_install
162 # Call elisp-install to install all Emacs Lisp (*.el and *.elc) files.
163 # If the SITEFILE variable specifies a site-init file, install it with
164 # elisp-site-file-install. Also install any GNU Info files listed in
165 # ELISP_TEXINFO and documentation listed in the DOCS variable.
167 elisp_src_install() {
168 elisp-install ${PN} *.el *.elc
169 if [[ -n ${SITEFILE} ]]; then
170 elisp-site-file-install "${FILESDIR}/${SITEFILE}"
172 if [[ -n ${ELISP_TEXINFO} ]]; then
173 set -- ${ELISP_TEXINFO}
175 doinfo ${@/%.*/.info*}
177 # install documentation only when explicitly requested
179 4|5) [[ -n ${DOCS} ]] && dodoc ${DOCS} ;;
180 *) declare -p DOCS &>/dev/null && einstalldocs ;;
182 if declare -f readme.gentoo_create_doc >/dev/null; then
183 readme.gentoo_create_doc
187 # @FUNCTION: elisp_pkg_postinst
189 # Call elisp-site-regen, in order to collect the site initialisation for
190 # all installed Emacs Lisp packages in the site-gentoo.el file.
192 elisp_pkg_postinst() {
194 if declare -f readme.gentoo_print_elog >/dev/null; then
195 readme.gentoo_print_elog
199 # @FUNCTION: elisp_pkg_postrm
201 # Call elisp-site-regen, in order to collect the site initialisation for
202 # all installed Emacs Lisp packages in the site-gentoo.el file.