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

Diff of /eclass/elisp.eclass

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

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