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

Diff of /eclass/elisp.eclass

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

Revision 1.2 Revision 1.54
1# Copyright 1999-2002 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.54 2011/12/03 08:54:46 ulm Exp $
4#
5# @ECLASS: elisp.eclass
6# @MAINTAINER:
7# Gentoo Emacs team <emacs@gentoo.org>
8# @AUTHOR:
3# Author Matthew Kennedy <mkennedy@gentoo.org> 9# Matthew Kennedy <mkennedy@gentoo.org>
4# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.2 2003/02/09 09:40:43 mkennedy Exp $ 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:
15#
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().
5 28
6# This eclass sets the site-lisp directory for emacs-related packages. 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.
7 35
8ECLASS=elisp 36# @ECLASS-VARIABLE: ELISP_PATCHES
9INHERITED="$INHERITED $ECLASS" 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.
10 42
11SITELISP=/usr/share/emacs/site-lisp 43# @ECLASS-VARIABLE: ELISP_REMOVE
44# @DEFAULT_UNSET
45# @DESCRIPTION:
46# Space separated list of files to remove after unpacking the sources.
12 47
13elisp-install() { 48# @ECLASS-VARIABLE: SITEFILE
14 local subdir=$1 49# @DEFAULT_UNSET
15 dodir ${SITELISP}/${subdir} 50# @DESCRIPTION:
16 insinto ${SITELISP}/${subdir} 51# Name of package's site-init file. The filename must match the shell
17 shift 52# pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
18 doins $@ 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
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
76
77DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
78RDEPEND="${DEPEND}"
79IUSE=""
80
81# @FUNCTION: elisp_pkg_setup
82# @DESCRIPTION:
83# Test if the eselected Emacs version is sufficient to fulfil the major
84# version requirement of the NEED_EMACS variable.
85
86elisp_pkg_setup() {
87 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
19} 88}
20 89
21elisp-site-file-install() { 90# @FUNCTION: elisp_src_unpack
22 local sitefile=$1 91# @DESCRIPTION:
23 pushd ${S} 92# Unpack the sources; also handle the case of a single *.el file in
24 cp ${sitefile} . 93# WORKDIR for packages distributed that way. For EAPIs without
25 D=${S}/ dosed "s:@SITELISP@:${SITELISP}/${PN}:g" $(basename ${sitefile}) 94# src_prepare, call elisp_src_prepare.
26 insinto ${SITELISP} 95
27 doins ${S}/$(basename ${sitefile}) 96elisp_src_unpack() {
28 popd 97 [[ -n ${A} ]] && unpack ${A}
98 if [[ -f ${P}.el ]]; then
99 # the "simple elisp" case with a single *.el file in WORKDIR
100 mv ${P}.el ${PN}.el || die
101 [[ -d ${S} ]] || S=${WORKDIR}
102 fi
103
104 case "${EAPI:-0}" in
105 0|1) [[ -d ${S} ]] && cd "${S}"
106 elisp_src_prepare ;;
107 esac
29} 108}
30 109
31elisp-site-regen() { 110# @FUNCTION: elisp_src_prepare
32 einfo "Regenerating ${SITELISP}/site-start.el..." 111# @DESCRIPTION:
33 einfo "" 112# Apply any patches listed in ELISP_PATCHES. Patch files are searched
34 cat <<EOF >${SITELISP}/site-start.el 113# for in the current working dir, WORKDIR, and FILESDIR.
35;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE
36;;; -----------------------------------------------------------------
37 114
38EOF 115elisp_src_prepare() {
39 ls ${SITELISP}/[0-9][0-9]* |sort -n |grep -vE '~$' | \ 116 local patch
40 while read sf 117 for patch in ${ELISP_PATCHES}; do
41 do 118 if [[ -f ${patch} ]]; then
42 einfo " Addding $sf..." 119 epatch "${patch}"
43 # Great for debugging, too noisy and slow for users though 120 elif [[ -f ${WORKDIR}/${patch} ]]; then
44# echo "(message \"Loading $sf...\")" >>${SITELISP}/site-start.el 121 epatch "${WORKDIR}/${patch}"
45 cat $sf >>${SITELISP}/site-start.el 122 elif [[ -f ${FILESDIR}/${patch} ]]; then
123 epatch "${FILESDIR}/${patch}"
124 else
125 die "Cannot find ${patch}"
126 fi
46 done 127 done
47 einfo "" 128
129 # apply any user patches
130 epatch_user
131
132 if [[ -n ${ELISP_REMOVE} ]]; then
133 rm ${ELISP_REMOVE} || die
134 fi
48} 135}
136
137# @FUNCTION: elisp_src_configure
138# @DESCRIPTION:
139# Do nothing, because Emacs packages seldomly bring a full build system.
140
141elisp_src_configure() { :; }
142
143# @FUNCTION: elisp_src_compile
144# @DESCRIPTION:
145# Call elisp-compile to byte-compile all Emacs Lisp (*.el) files.
146# If ELISP_TEXINFO lists any Texinfo sources, call makeinfo to generate
147# GNU Info files from them.
148
149elisp_src_compile() {
150 elisp-compile *.el || die
151 if [[ -n ${ELISP_TEXINFO} ]]; then
152 makeinfo ${ELISP_TEXINFO} || die
153 fi
154}
155
156# @FUNCTION: elisp_src_install
157# @DESCRIPTION:
158# Call elisp-install to install all Emacs Lisp (*.el and *.elc) files.
159# If the SITEFILE variable specifies a site-init file, install it with
160# elisp-site-file-install. Also install any GNU Info files listed in
161# ELISP_TEXINFO and documentation listed in the DOCS variable.
162
163elisp_src_install() {
164 elisp-install ${PN} *.el *.elc || die
165 if [[ -n ${SITEFILE} ]]; then
166 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
167 fi
168 if [[ -n ${ELISP_TEXINFO} ]]; then
169 set -- ${ELISP_TEXINFO}
170 set -- ${@##*/}
171 doinfo ${@/%.*/.info*} || die
172 fi
173 if [[ -n ${DOCS} ]]; then
174 dodoc ${DOCS} || die
175 fi
176}
177
178# @FUNCTION: elisp_pkg_postinst
179# @DESCRIPTION:
180# Call elisp-site-regen, in order to collect the site initialisation for
181# all installed Emacs Lisp packages in the site-gentoo.el file.
182
183elisp_pkg_postinst() {
184 elisp-site-regen
185}
186
187# @FUNCTION: elisp_pkg_postrm
188# @DESCRIPTION:
189# Call elisp-site-regen, in order to collect the site initialisation for
190# all installed Emacs Lisp packages in the site-gentoo.el file.
191
192elisp_pkg_postrm() {
193 elisp-site-regen
194}

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.54

  ViewVC Help
Powered by ViewVC 1.1.20