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

Diff of /eclass/elisp.eclass

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

Revision 1.31 Revision 1.52
1# Copyright 1999-2008 Gentoo Foundation 1# Copyright 1999-2011 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.31 2008/06/23 13:40:23 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.52 2011/08/30 20:10:13 ulm Exp $
4#
5# Copyright 2002-2003 Matthew Kennedy <mkennedy@gentoo.org>
6# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
7# Copyright 2007 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
38inherit elisp-common versionator 36# @ECLASS-VARIABLE: ELISP_PATCHES
37# @DEFAULT_UNSET
38# @DESCRIPTION:
39# Any patches to apply after unpacking the sources. Patch files are
40# searched for in the current working dir, WORKDIR, and FILESDIR.
39 41
40VERSION=${NEED_EMACS:-21} 42# @ECLASS-VARIABLE: SITEFILE
43# @DEFAULT_UNSET
44# @DESCRIPTION:
45# Name of package's site-init file. The filename must match the shell
46# pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
47# reserved for internal use. "50${PN}-gentoo.el" is a reasonable choice
48# in most cases.
49
50# @ECLASS-VARIABLE: ELISP_TEXINFO
51# @DEFAULT_UNSET
52# @DESCRIPTION:
53# Space separated list of Texinfo sources. Respective GNU Info files
54# will be generated in src_compile() and installed in src_install().
55
56# @ECLASS-VARIABLE: DOCS
57# @DEFAULT_UNSET
58# @DESCRIPTION:
59# DOCS="blah.txt ChangeLog" is automatically used to install the given
60# files by dodoc in src_install().
61
62inherit elisp-common eutils
63
64case "${EAPI:-0}" in
65 0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \
66 pkg_{setup,postinst,postrm} ;;
67 *) EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
68 pkg_{setup,postinst,postrm} ;;
69esac
70
41DEPEND=">=virtual/emacs-${VERSION}" 71DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
42RDEPEND=">=virtual/emacs-${VERSION}" 72RDEPEND="${DEPEND}"
43IUSE="" 73IUSE=""
44 74
75# @FUNCTION: elisp_pkg_setup
76# @DESCRIPTION:
77# Test if the eselected Emacs version is sufficient to fulfil the major
78# version requirement of the NEED_EMACS variable.
79
45elisp_pkg_setup() { 80elisp_pkg_setup() {
46 local emacs_version="$(elisp-emacs-version)" 81 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
47 if ! version_is_at_least "${VERSION}" "${emacs_version}"; then
48 eerror "This package needs at least Emacs ${VERSION}."
49 eerror "Use \"eselect emacs\" to select the active version."
50 die "Emacs version ${emacs_version} is too low."
51 fi
52 einfo "Emacs version: ${emacs_version}"
53} 82}
54 83
84# @FUNCTION: elisp_src_unpack
85# @DESCRIPTION:
86# Unpack the sources; also handle the case of a single *.el file in
87# WORKDIR for packages distributed that way. For EAPIs without
88# src_prepare, call elisp_src_prepare.
89
55elisp_src_unpack() { 90elisp_src_unpack() {
56 unpack ${A} 91 [[ -n ${A} ]] && unpack ${A}
57 if [ -f ${P}.el ]; then 92 if [[ -f ${P}.el ]]; then
58 mv ${P}.el ${PN}.el || die "mv ${P}.el ${PN}.el failed" 93 # the "simple elisp" case with a single *.el file in WORKDIR
94 mv ${P}.el ${PN}.el || die
95 [[ -d ${S} ]] || S=${WORKDIR}
96 fi
97
98 case "${EAPI:-0}" in
99 0|1) [[ -d ${S} ]] && cd "${S}"
100 elisp_src_prepare ;;
101 esac
102}
103
104# @FUNCTION: elisp_src_prepare
105# @DESCRIPTION:
106# Apply any patches listed in ELISP_PATCHES. Patch files are searched
107# for in the current working dir, WORKDIR, and FILESDIR.
108
109elisp_src_prepare() {
110 local patch
111 for patch in ${ELISP_PATCHES}; do
112 if [[ -f ${patch} ]]; then
113 epatch "${patch}"
114 elif [[ -f ${WORKDIR}/${patch} ]]; then
115 epatch "${WORKDIR}/${patch}"
116 elif [[ -f ${FILESDIR}/${patch} ]]; then
117 epatch "${FILESDIR}/${patch}"
118 else
119 die "Cannot find ${patch}"
120 fi
121 done
122}
123
124# @FUNCTION: elisp_src_configure
125# @DESCRIPTION:
126# Do nothing, because Emacs packages seldomly bring a full build system.
127
128elisp_src_configure() { :; }
129
130# @FUNCTION: elisp_src_compile
131# @DESCRIPTION:
132# Call elisp-compile to byte-compile all Emacs Lisp (*.el) files.
133# If ELISP_TEXINFO lists any Texinfo sources, call makeinfo to generate
134# GNU Info files from them.
135
136elisp_src_compile() {
137 elisp-compile *.el || die
138 if [[ -n ${ELISP_TEXINFO} ]]; then
139 makeinfo ${ELISP_TEXINFO} || die
59 fi 140 fi
60} 141}
61 142
143# @FUNCTION: elisp_src_install
144# @DESCRIPTION:
145# Call elisp-install to install all Emacs Lisp (*.el and *.elc) files.
146# If the SITEFILE variable specifies a site-init file, install it with
147# elisp-site-file-install. Also install any GNU Info files listed in
148# ELISP_TEXINFO and documentation listed in the DOCS variable.
149
62elisp_src_compile() { 150elisp_src_install() {
63 elisp-compile *.el || die "elisp-compile failed" 151 elisp-install ${PN} *.el *.elc || die
152 if [[ -n ${SITEFILE} ]]; then
153 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
154 fi
155 if [[ -n ${ELISP_TEXINFO} ]]; then
156 set -- ${ELISP_TEXINFO}
157 set -- ${@##*/}
158 doinfo ${@/%.*/.info*} || die
159 fi
160 if [[ -n ${DOCS} ]]; then
161 dodoc ${DOCS} || die
162 fi
64} 163}
65 164
66elisp_src_install() { 165# @FUNCTION: elisp_pkg_postinst
67 elisp-install ${PN} *.el *.elc || die "elisp-install failed" 166# @DESCRIPTION:
68 elisp-site-file-install "${FILESDIR}/${SITEFILE}" \ 167# Call elisp-site-regen, in order to collect the site initialisation for
69 || die "elisp-site-file-install failed" 168# all installed Emacs Lisp packages in the site-gentoo.el file.
70 if [ -n "${DOCS}" ]; then
71 dodoc ${DOCS} || die "dodoc failed"
72 fi
73}
74 169
75elisp_pkg_postinst() { 170elisp_pkg_postinst() {
76 elisp-site-regen 171 elisp-site-regen
77} 172}
78 173
174# @FUNCTION: elisp_pkg_postrm
175# @DESCRIPTION:
176# Call elisp-site-regen, in order to collect the site initialisation for
177# all installed Emacs Lisp packages in the site-gentoo.el file.
178
79elisp_pkg_postrm() { 179elisp_pkg_postrm() {
80 elisp-site-regen 180 elisp-site-regen
81} 181}
82
83EXPORT_FUNCTIONS \
84 src_unpack src_compile src_install \
85 pkg_setup pkg_postinst pkg_postrm
Legend:
Removed from v.1.31  
changed lines
  Added in v.1.52
  ViewVC Help
Powered by ViewVC 1.1.13