/[gentoo-x86]/eclass/elisp.eclass
Gentoo

Diff of /eclass/elisp.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.34 Revision 1.55
1# Copyright 1999-2008 Gentoo Foundation 1# Copyright 1999-2012 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.34 2008/09/19 08:12:48 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.55 2012/08/17 20:29:24 ulm Exp $
4#
5# Copyright 2002-2003 Matthew Kennedy <mkennedy@gentoo.org>
6# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
7# Copyright 2007-2008 Christian Faulhammer <opfer@gentoo.org>
8# Copyright 2007-2008 Ulrich Müller <ulm@gentoo.org>
9# 4#
10# @ECLASS: elisp.eclass 5# @ECLASS: elisp.eclass
11# @MAINTAINER: 6# @MAINTAINER:
12# Feel free to contact the Emacs team through <emacs@gentoo.org> if you 7# Gentoo Emacs team <emacs@gentoo.org>
13# have problems, suggestions or questions. 8# @AUTHOR:
9# Matthew Kennedy <mkennedy@gentoo.org>
10# Jeremy Maitin-Shepard <jbms@attbi.com>
11# Christian Faulhammer <fauli@gentoo.org>
12# Ulrich Müller <ulm@gentoo.org>
14# @BLURB: Eclass for Emacs Lisp packages 13# @BLURB: Eclass for Emacs Lisp packages
15# @DESCRIPTION: 14# @DESCRIPTION:
16# 15#
17# This eclass sets the site-lisp directory for Emacs-related 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.
18# 20#
19# Emacs support for other than pure elisp packages is handled by 21# Emacs support for other than pure elisp packages is handled by
20# elisp-common.eclass where you won't have a dependency on Emacs itself. 22# elisp-common.eclass where you won't have a dependency on Emacs itself.
21# All elisp-* functions are documented there. 23# All elisp-* functions are documented there.
22# 24#
23# If the package's source is a single (in whatever way) compressed elisp 25# If the package's source is a single (in whatever way) compressed elisp
24# file with the file name ${P}.el, then this eclass will move ${P}.el to 26# file with the file name ${P}.el, then this eclass will move ${P}.el to
25# ${PN}.el in src_unpack(). 27# ${PN}.el in src_unpack().
26 28
27# @ECLASS-VARIABLE: DOCS
28# @DESCRIPTION:
29# DOCS="blah.txt ChangeLog" is automatically used to install the given
30# files by dodoc in src_install().
31
32# @ECLASS-VARIABLE: NEED_EMACS 29# @ECLASS-VARIABLE: NEED_EMACS
30# @DEFAULT_UNSET
33# @DESCRIPTION: 31# @DESCRIPTION:
34# If you need anything different from Emacs 21, use the NEED_EMACS 32# If you need anything different from Emacs 21, use the NEED_EMACS
35# variable before inheriting elisp.eclass. Set it to the major version 33# variable before inheriting elisp.eclass. Set it to the major version
36# your package uses and the dependency will be adjusted. 34# your package uses and the dependency will be adjusted.
37 35
36# @ECLASS-VARIABLE: ELISP_PATCHES
37# @DEFAULT_UNSET
38# @DESCRIPTION:
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.
42
43# @ECLASS-VARIABLE: ELISP_REMOVE
44# @DEFAULT_UNSET
45# @DESCRIPTION:
46# Space separated list of files to remove after unpacking the sources.
47
48# @ECLASS-VARIABLE: SITEFILE
49# @DEFAULT_UNSET
50# @DESCRIPTION:
51# Name of package's site-init file. The filename must match the shell
52# pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
53# reserved for internal use. "50${PN}-gentoo.el" is a reasonable choice
54# in most cases.
55
56# @ECLASS-VARIABLE: ELISP_TEXINFO
57# @DEFAULT_UNSET
58# @DESCRIPTION:
59# Space separated list of Texinfo sources. Respective GNU Info files
60# will be generated in src_compile() and installed in src_install().
61
62# @ECLASS-VARIABLE: DOCS
63# @DEFAULT_UNSET
64# @DESCRIPTION:
65# DOCS="blah.txt ChangeLog" is automatically used to install the given
66# files by dodoc in src_install().
67
38inherit elisp-common versionator 68inherit elisp-common eutils
69
70case "${EAPI:-0}" in
71 0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \
72 pkg_{setup,postinst,postrm} ;;
73 *) EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
74 pkg_{setup,postinst,postrm} ;;
75esac
39 76
40DEPEND=">=virtual/emacs-${NEED_EMACS:-21}" 77DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
41RDEPEND=">=virtual/emacs-${NEED_EMACS:-21}" 78RDEPEND="${DEPEND}"
42IUSE="" 79
80# @FUNCTION: elisp_pkg_setup
81# @DESCRIPTION:
82# Test if the eselected Emacs version is sufficient to fulfil the major
83# version requirement of the NEED_EMACS variable.
43 84
44elisp_pkg_setup() { 85elisp_pkg_setup() {
45 local need_emacs=${NEED_EMACS:-21} 86 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
46 local have_emacs=$(elisp-emacs-version) 87}
47 if ! version_is_at_least "${need_emacs}" "${have_emacs}"; then 88
48 eerror "This package needs at least Emacs ${need_emacs}." 89# @FUNCTION: elisp_src_unpack
49 eerror "Use \"eselect emacs\" to select the active version." 90# @DESCRIPTION:
50 die "Emacs version ${have_emacs} is too low." 91# Unpack the sources; also handle the case of a single *.el file in
92# WORKDIR for packages distributed that way. For EAPIs without
93# src_prepare, call elisp_src_prepare.
94
95elisp_src_unpack() {
96 [[ -n ${A} ]] && unpack ${A}
97 if [[ -f ${P}.el ]]; then
98 # the "simple elisp" case with a single *.el file in WORKDIR
99 mv ${P}.el ${PN}.el || die
100 [[ -d ${S} ]] || S=${WORKDIR}
101 fi
102
103 case "${EAPI:-0}" in
104 0|1) [[ -d ${S} ]] && cd "${S}"
105 elisp_src_prepare ;;
106 esac
107}
108
109# @FUNCTION: elisp_src_prepare
110# @DESCRIPTION:
111# Apply any patches listed in ELISP_PATCHES. Patch files are searched
112# for in the current working dir, WORKDIR, and FILESDIR.
113
114elisp_src_prepare() {
115 local patch
116 for patch in ${ELISP_PATCHES}; do
117 if [[ -f ${patch} ]]; then
118 epatch "${patch}"
119 elif [[ -f ${WORKDIR}/${patch} ]]; then
120 epatch "${WORKDIR}/${patch}"
121 elif [[ -f ${FILESDIR}/${patch} ]]; then
122 epatch "${FILESDIR}/${patch}"
123 else
124 die "Cannot find ${patch}"
125 fi
126 done
127
128 # apply any user patches
129 epatch_user
130
131 if [[ -n ${ELISP_REMOVE} ]]; then
132 rm ${ELISP_REMOVE} || die
51 fi 133 fi
52} 134}
53 135
54elisp_src_unpack() { 136# @FUNCTION: elisp_src_configure
55 [ -n "${A}" ] && unpack ${A} 137# @DESCRIPTION:
56 if [ -f ${P}.el ]; then 138# Do nothing, because Emacs packages seldomly bring a full build system.
57 mv ${P}.el ${PN}.el || die "mv ${P}.el ${PN}.el failed" 139
140elisp_src_configure() { :; }
141
142# @FUNCTION: elisp_src_compile
143# @DESCRIPTION:
144# Call elisp-compile to byte-compile all Emacs Lisp (*.el) files.
145# If ELISP_TEXINFO lists any Texinfo sources, call makeinfo to generate
146# GNU Info files from them.
147
148elisp_src_compile() {
149 elisp-compile *.el || die
150 if [[ -n ${ELISP_TEXINFO} ]]; then
151 makeinfo ${ELISP_TEXINFO} || die
58 fi 152 fi
59} 153}
60 154
155# @FUNCTION: elisp_src_install
156# @DESCRIPTION:
157# Call elisp-install to install all Emacs Lisp (*.el and *.elc) files.
158# If the SITEFILE variable specifies a site-init file, install it with
159# elisp-site-file-install. Also install any GNU Info files listed in
160# ELISP_TEXINFO and documentation listed in the DOCS variable.
161
61elisp_src_compile() { 162elisp_src_install() {
62 elisp-compile *.el || die "elisp-compile failed" 163 elisp-install ${PN} *.el *.elc || die
164 if [[ -n ${SITEFILE} ]]; then
165 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
166 fi
167 if [[ -n ${ELISP_TEXINFO} ]]; then
168 set -- ${ELISP_TEXINFO}
169 set -- ${@##*/}
170 doinfo ${@/%.*/.info*} || die
171 fi
172 if [[ -n ${DOCS} ]]; then
173 dodoc ${DOCS} || die
174 fi
63} 175}
64 176
65elisp_src_install() { 177# @FUNCTION: elisp_pkg_postinst
66 elisp-install ${PN} *.el *.elc || die "elisp-install failed" 178# @DESCRIPTION:
67 elisp-site-file-install "${FILESDIR}/${SITEFILE}" \ 179# Call elisp-site-regen, in order to collect the site initialisation for
68 || die "elisp-site-file-install failed" 180# all installed Emacs Lisp packages in the site-gentoo.el file.
69 if [ -n "${DOCS}" ]; then
70 dodoc ${DOCS} || die "dodoc failed"
71 fi
72}
73 181
74elisp_pkg_postinst() { 182elisp_pkg_postinst() {
75 elisp-site-regen 183 elisp-site-regen
76} 184}
77 185
186# @FUNCTION: elisp_pkg_postrm
187# @DESCRIPTION:
188# Call elisp-site-regen, in order to collect the site initialisation for
189# all installed Emacs Lisp packages in the site-gentoo.el file.
190
78elisp_pkg_postrm() { 191elisp_pkg_postrm() {
79 elisp-site-regen 192 elisp-site-regen
80} 193}
81
82EXPORT_FUNCTIONS \
83 src_unpack src_compile src_install \
84 pkg_setup pkg_postinst pkg_postrm

Legend:
Removed from v.1.34  
changed lines
  Added in v.1.55

  ViewVC Help
Powered by ViewVC 1.1.20