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

Diff of /eclass/elisp.eclass

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

Revision 1.8 Revision 1.52
1# Copyright 1999-2003 Gentoo Technologies, Inc. 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.8 2003/09/21 01:40:41 mkennedy Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.52 2011/08/30 20:10:13 ulm Exp $
4# 4#
5# @ECLASS: elisp.eclass
6# @MAINTAINER:
7# Gentoo Emacs team <emacs@gentoo.org>
8# @AUTHOR:
5# Author Matthew Kennedy <mkennedy@gentoo.org> 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>
13# @BLURB: Eclass for Emacs Lisp packages
14# @DESCRIPTION:
6# 15#
7# 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.
20#
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.
24#
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().
8 28
9inherit elisp-common 29# @ECLASS-VARIABLE: NEED_EMACS
30# @DEFAULT_UNSET
31# @DESCRIPTION:
32# If you need anything different from Emacs 21, 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.
10 35
11ECLASS=elisp 36# @ECLASS-VARIABLE: ELISP_PATCHES
12INHERITED="$INHERITED $ECLASS" 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.
13 41
14source /usr/portage/eclass/elisp-common.eclass 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.
15 49
16# SRC_URI should be set to wherever the primary app-emacs/ maintainer 50# @ECLASS-VARIABLE: ELISP_TEXINFO
17# keeps the local elisp mirror, since most app-emacs packages are 51# @DEFAULT_UNSET
18# upstream as a single .el file. 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().
19 55
20# Note: This is no longer necessary. 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().
21 61
22SRC_URI="http://cvs.gentoo.org/~mkennedy/app-emacs/${P}.el.bz2" 62inherit elisp-common eutils
23S="${WORKDIR}/" 63
24newdepend "virtual/emacs" 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
71DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
72RDEPEND="${DEPEND}"
25IUSE="" 73IUSE=""
26 74
27src_unpack() { 75# @FUNCTION: elisp_pkg_setup
28 unpack ${A} 76# @DESCRIPTION:
29 if [ "${SIMPLE_ELISP}" = 't' ] 77# Test if the eselected Emacs version is sufficient to fulfil the major
30 then 78# version requirement of the NEED_EMACS variable.
31 cd ${S} && mv ${P}.el ${PN}.el 79
32 fi 80elisp_pkg_setup() {
81 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
33} 82}
34 83
35src_compile() { 84# @FUNCTION: elisp_src_unpack
36 emacs --batch -f batch-byte-compile --no-site-file --no-init-file *.el || die 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
90elisp_src_unpack() {
91 [[ -n ${A} ]] && unpack ${A}
92 if [[ -f ${P}.el ]]; then
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
37} 102}
38 103
39src_install() { 104# @FUNCTION: elisp_src_prepare
40 elisp-install ${PN} *.el *.elc 105# @DESCRIPTION:
41 elisp-site-file-install ${FILESDIR}/${SITEFILE} 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
42} 122}
43 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
140 fi
141}
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
150elisp_src_install() {
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
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.
169
44pkg_postinst() { 170elisp_pkg_postinst() {
45 elisp-site-regen 171 elisp-site-regen
46} 172}
47 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
48pkg_postrm() { 179elisp_pkg_postrm() {
49 elisp-site-regen 180 elisp-site-regen
50} 181}
51
52# Local Variables: ***
53# mode: shell-script ***
54# tab-width: 4 ***
55# indent-tabs-mode: t ***
56# End: ***

Legend:
Removed from v.1.8  
changed lines
  Added in v.1.52

  ViewVC Help
Powered by ViewVC 1.1.20