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

Diff of /eclass/elisp.eclass

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

Revision 1.1.1.1 Revision 1.48
1# Copyright 1999-2004 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.1.1.1 2005/11/30 09:59:37 chriswhite Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.48 2011/02/07 21:48:53 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-2010 Christian Faulhammer <fauli@gentoo.org>
8# Copyright 2007-2010 Ulrich Müller <ulm@gentoo.org>
7# 9#
8# This eclass sets the site-lisp directory for emacs-related packages. 10# @ECLASS: elisp.eclass
11# @MAINTAINER:
12# Feel free to contact the Emacs team through <emacs@gentoo.org> if you
13# have problems, suggestions or questions.
14# @BLURB: Eclass for Emacs Lisp packages
15# @DESCRIPTION:
16#
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.
21#
22# Emacs support for other than pure elisp packages is handled by
23# elisp-common.eclass where you won't have a dependency on Emacs itself.
24# All elisp-* functions are documented there.
25#
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().
9 29
10inherit elisp-common 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.
11 36
12# SRC_URI should be set to wherever the primary app-emacs/ maintainer 37# @ECLASS-VARIABLE: ELISP_PATCHES
13# keeps the local elisp mirror, since most app-emacs packages are 38# @DEFAULT_UNSET
14# upstream as a single .el file. 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.
15 42
16# Note: This is no longer necessary. 43# @ECLASS-VARIABLE: SITEFILE
44# @DEFAULT_UNSET
45# @DESCRIPTION:
46# Name of package's site-init file. The filename must match the shell
47# pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
48# reserved for internal use. "50${PN}-gentoo.el" is a reasonable choice
49# in most cases.
17 50
18SRC_URI="http://cvs.gentoo.org/~mkennedy/app-emacs/${P}.el.bz2" 51# @ECLASS-VARIABLE: ELISP_TEXINFO
19if [ "${SIMPLE_ELISP}" = 't' ]; then 52# @DEFAULT_UNSET
20 S="${WORKDIR}/" 53# @DESCRIPTION:
21#else 54# Space separated list of Texinfo sources. Respective GNU Info files
22# Use default value 55# will be generated in src_compile() and installed in src_install().
23# S="${WORKDIR}/${P}"
24fi
25 56
26DEPEND="virtual/emacs" 57# @ECLASS-VARIABLE: DOCS
58# @DEFAULT_UNSET
59# @DESCRIPTION:
60# DOCS="blah.txt ChangeLog" is automatically used to install the given
61# files by dodoc in src_install().
62
63inherit elisp-common eutils
64
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
71
72DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
73RDEPEND="${DEPEND}"
27IUSE="" 74IUSE=""
28 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
81elisp_pkg_setup() {
82 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
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.
90
29elisp_src_unpack() { 91elisp_src_unpack() {
30 unpack ${A} 92 [ -n "${A}" ] && unpack ${A}
31 if [ "${SIMPLE_ELISP}" = 't' ] 93 if [ -f ${P}.el ]; then
32 then 94 # the "simple elisp" case with a single *.el file in WORKDIR
33 cd ${S} && mv ${P}.el ${PN}.el 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 them.
136
137elisp_src_compile() {
138 elisp-compile *.el || die
139 if [ -n "${ELISP_TEXINFO}" ]; then
140 makeinfo ${ELISP_TEXINFO} || die
34 fi 141 fi
35} 142}
36 143
144# @FUNCTION: elisp_src_install
145# @DESCRIPTION:
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.
150
37elisp_src_compile() { 151elisp_src_install() {
38 elisp-compile *.el || die 152 elisp-install ${PN} *.el *.elc || die
153 if [ -n "${SITEFILE}" ]; then
154 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
155 fi
156 if [ -n "${ELISP_TEXINFO}" ]; then
157 set -- ${ELISP_TEXINFO}
158 doinfo ${@/%.*/.info*} || die
159 fi
160 if [ -n "${DOCS}" ]; then
161 dodoc ${DOCS} || die
162 fi
39} 163}
40 164
41elisp_src_install() { 165# @FUNCTION: elisp_pkg_postinst
42 elisp-install ${PN} *.el *.elc 166# @DESCRIPTION:
43 elisp-site-file-install ${FILESDIR}/${SITEFILE} 167# Call elisp-site-regen, in order to collect the site initialisation for
44} 168# all installed Emacs Lisp packages in the site-gentoo.el file.
45 169
46elisp_pkg_postinst() { 170elisp_pkg_postinst() {
47 elisp-site-regen 171 elisp-site-regen
48} 172}
49 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
50elisp_pkg_postrm() { 179elisp_pkg_postrm() {
51 elisp-site-regen 180 elisp-site-regen
52} 181}
53
54EXPORT_FUNCTIONS src_unpack src_compile src_install \
55 pkg_postinst pkg_postrm
56
57# Local Variables: ***
58# mode: shell-script ***
59# tab-width: 4 ***
60# indent-tabs-mode: t ***
61# End: ***
Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.48
  ViewVC Help
Powered by ViewVC 1.1.20