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

Diff of /eclass/elisp.eclass

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

Revision 1.17 Revision 1.40
1# Copyright 1999-2007 Gentoo Foundation 1# Copyright 1999-2009 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.17 2007/04/16 15:35:56 opfer Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.40 2009/03/29 19:49:45 ulm Exp $
4# 4#
5# Copyright 2007 Christian Faulhammer <opfer@gentoo.org>
6# Copyright 2002-2007 Matthew Kennedy <mkennedy@gentoo.org> 5# Copyright 2002-2003 Matthew Kennedy <mkennedy@gentoo.org>
7# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com> 6# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
7# Copyright 2007-2009 Christian Faulhammer <fauli@gentoo.org>
8# Copyright 2007 Ulrich Mueller <ulm@gentoo.org> 8# Copyright 2007-2009 Ulrich M├╝ller <ulm@gentoo.org>
9# 9#
10# This is not a real eclass, but it does provide Emacs-related installation 10# @ECLASS: elisp.eclass
11# utilities. 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:
12# 16#
13# USAGE: 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.
14# 21#
15# Usually you want to use this eclass for (optional) GNU Emacs support of 22# Emacs support for other than pure elisp packages is handled by
16# your package. This is NOT for XEmacs! 23# elisp-common.eclass where you won't have a dependency on Emacs itself.
17# Many of the steps here are sometimes done by the build system of your 24# All elisp-* functions are documented there.
18# package (especially compilation), so this is mainly for standalone elisp
19# files you gathered from somewhere else.
20# When relying on the emacs USE flag, you need to add
21# 25#
22# emacs? ( virtual/emacs ) 26# If the package's source is a single (in whatever way) compressed elisp
23# 27# file with the file name ${P}.el, then this eclass will move ${P}.el to
24# to your DEPEND/RDEPEND line and use the functions provided here to bring 28# ${PN}.el in src_unpack().
25# the files to the correct locations.
26#
27# src_compile() usage:
28# --------------------
29#
30# An elisp file is compiled by the elisp-compile() function defined here and
31# simply takes the source files as arguments. In the case of interdependent
32# elisp files, you can use the elisp-comp() function which makes sure all
33# files are loadable.
34#
35# elisp-compile *.el || die "elisp-compile failed!"
36# or
37# elisp-comp *.el || die "elisp-comp failed!"
38#
39# Function elisp-make-autoload-file() can be used to generate a file with
40# autoload definitions for the lisp functions. It takes the output file name
41# (default: "${PN}-autoloads.el") and a list of directories (default: working
42# directory) as its arguments. Use of this function requires that the elisp
43# source files contain magic ";;;###autoload" comments. See the Emacs Lisp
44# Reference Manual (node "Autoload") for a detailed explanation.
45#
46# src_install() usage:
47# --------------------
48#
49# The resulting compiled files (.elc) should be put in a subdirectory of
50# /usr/share/emacs/site-lisp/ which is named after the first argument
51# of elisp-install(). The following parameters are the files to be put in
52# that directory. Usually the subdirectory should be ${PN}, you can choose
53# something else, but remember to tell elisp-site-file-install() (see below)
54# the change, as it defaults to ${PN}.
55#
56# elisp-install ${PN} *.elc *.el || die "elisp-install failed!"
57#
58# To let the Emacs support be activated by Emacs on startup, you need
59# to provide a site file (shipped in ${FILESDIR}) which contains the startup
60# code (have a look in the documentation of your software). Normally this
61# would look like this:
62#
63# ;;; csv-mode site-lisp configuration
64#
65# (add-to-list 'load-path "@SITELISP@")
66# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
67# (autoload 'csv-mode "csv-mode" "Major mode for editing csv files." t)
68#
69# If your Emacs support files are installed in a subdirectory of
70# /usr/share/emacs/site-lisp/ (which is recommended if more than one file is
71# installed), you need to extend Emacs' load-path as shown in the first
72# non-comment. The elisp-site-file-install() function of this eclass will
73# replace "@SITELISP@" by the actual path.
74# The next line tells Emacs to load the mode opening a file ending with
75# ".csv" and load functions depending on the context and needed features.
76# Be careful though. Commands as "load-library" or "require" bloat the
77# editor as they are loaded on every startup. When having a lot of Emacs
78# support files, users may be annoyed by the start-up time. Also avoid
79# keybindings as they might interfere with the user's settings. Give a hint
80# in pkg_postinst(), which should be enough.
81# The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the
82# two digits at the beginning define the loading order. So if you depend on
83# another Emacs package, your site file's number must be higher!
84# Best practice is to define a SITEFILE variable in the global scope of your
85# ebuild (right after DEPEND e.g.):
86#
87# SITEFILE=50${PN}-gentoo.el
88#
89# Which is then installed by
90#
91# elisp-site-file-install "${FILESDIR}/${SITEFILE}"
92#
93# in src_install(). If your subdirectory is not named ${PN}, give the
94# differing name as second argument.
95#
96# pkg_postinst() / pkg_postrm() usage:
97# ------------------------------------
98#
99# After that you need to recreate the start-up file of Emacs after emerging
100# and unmerging by using
101#
102# pkg_postinst() {
103# elisp-site-regen
104# }
105# pkg_postrm() {
106# elisp-site-regen
107# }
108#
109# As always: Feel free to contact Emacs team through emacs@gentoo.org if you
110# have problems, suggestions or questions.
111 29
112SITELISP=/usr/share/emacs/site-lisp 30# @ECLASS-VARIABLE: NEED_EMACS
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.
113 35
114elisp-compile() { 36# @ECLASS-VARIABLE: DOCS
115 /usr/bin/emacs --batch -f batch-byte-compile --no-site-file --no-init-file $* 37# @DESCRIPTION:
38# DOCS="blah.txt ChangeLog" is automatically used to install the given
39# files by dodoc in src_install().
40
41# @ECLASS-VARIABLE: ELISP_PATCHES
42# @DESCRIPTION:
43# Any patches to apply after unpacking the sources. Patches are searched
44# both in ${PWD} and ${FILESDIR}.
45
46# @ECLASS-VARIABLE: SITEFILE
47# @DESCRIPTION:
48# Name of package's site-init file. The filename must match the shell
49# pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
50# reserved for internal use. "50${PN}-gentoo.el" is a reasonable choice
51# in most cases.
52
53inherit elisp-common eutils versionator
54
55case "${EAPI:-0}" in
56 0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \
57 pkg_{setup,postinst,postrm} ;;
58 *) EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
59 pkg_{setup,postinst,postrm} ;;
60esac
61
62DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
63RDEPEND="${DEPEND}"
64IUSE=""
65
66elisp_pkg_setup() {
67 local need_emacs=${NEED_EMACS:-21}
68 local have_emacs=$(elisp-emacs-version)
69 if ! version_is_at_least "${need_emacs}" "${have_emacs}"; then
70 eerror "This package needs at least Emacs ${need_emacs}."
71 eerror "Use \"eselect emacs\" to select the active version."
72 die "Emacs version ${have_emacs} is too low."
73 fi
74 einfo "Emacs version: ${have_emacs}"
116} 75}
117 76
118elisp-make-autoload-file () { 77elisp_src_unpack() {
119 local f="${1-${PN}-autoloads.el}" 78 [ -n "${A}" ] && unpack ${A}
120 shift 79 if [ -f ${P}.el ]; then
121 echo >"${f}" 80 # the "simple elisp" case with a single *.el file in WORKDIR
122 emacs --batch -q --no-site-file \ 81 mv ${P}.el ${PN}.el || die
123 --eval "(setq make-backup-files nil)" \ 82 [ -d "${S}" ] || S=${WORKDIR}
124 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 83 fi
125 -f batch-update-autoloads "${@-.}" 84
85 case "${EAPI:-0}" in
86 0|1) elisp_src_prepare ;;
87 esac
126} 88}
127 89
128elisp-install() { 90elisp_src_prepare() {
129 local subdir=$1 91 local patch
130 dodir "${SITELISP}/${subdir}" 92 for patch in ${ELISP_PATCHES}; do
131 insinto "${SITELISP}/${subdir}" 93 if [ -f "${patch}" ]; then
132 shift 94 epatch "${patch}"
133 doins $@ 95 elif [ -f "${FILESDIR}/${patch}" ]; then
96 epatch "${FILESDIR}/${patch}"
97 else
98 die "Cannot find ${patch}"
99 fi
100 done
134} 101}
135 102
136elisp-site-file-install() { 103elisp_src_configure() { :; }
137 local sitefile=$1 my_pn=${2:-${PN}} 104
138 pushd "${S}" 105elisp_src_compile() {
139 cp ${sitefile} "${T}" 106 elisp-compile *.el || die
140 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})"
141 insinto ${SITELISP}
142 doins "${T}/$(basename ${sitefile})" || die "failed to install site file"
143 popd
144} 107}
145 108
146elisp-site-regen() { 109elisp_src_install() {
147 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 110 elisp-install ${PN} *.el *.elc || die
148 einfo "" 111 if [ -n "${SITEFILE}" ]; then
149 cat <<EOF >${ROOT}${SITELISP}/site-gentoo.el 112 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
150;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE 113 fi
151;;; ----------------------------------------------------------------- 114 if [ -n "${DOCS}" ]; then
152 115 dodoc ${DOCS} || die
153EOF 116 fi
154 ls ${ROOT}${SITELISP}/[0-9][0-9]*-gentoo.el | sort -n | \
155 while read sf
156 do
157 einfo " Adding $(basename $sf) ..."
158 # Great for debugging, too noisy and slow for users though
159# echo "(message \"Loading $sf ...\")" >>${ROOT}${SITELISP}/site-start.el
160 cat $sf >>${ROOT}${SITELISP}/site-gentoo.el
161 done
162 while read line; do einfo "${line}"; done <<EOF
163
164All site initialization for Gentoo-installed packages is now added to
165/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
166managed by Gentoo. You are responsible for all maintenance of
167site-start.el if there is such a file.
168
169In order for this site initialization to be loaded for all users
170automatically, as was done previously, you can add a line like this:
171
172 (load "/usr/share/emacs/site-lisp/site-gentoo")
173
174to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
175can be added by individual users to their initialization files, or for
176greater flexibility, users can select which of the package-specific
177initialization files in /usr/share/emacs/site-lisp to load.
178EOF
179 echo
180} 117}
181 118
182# The following Emacs Lisp compilation routine is taken from GNU 119elisp_pkg_postinst() {
183# autotools. 120 elisp-site-regen
121}
184 122
185elisp-comp() { 123elisp_pkg_postrm() {
186# Copyright 1995 Free Software Foundation, Inc. 124 elisp-site-regen
187# Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995.
188# This script byte-compiles all `.el' files which are part of its
189# arguments, using GNU Emacs, and put the resulting `.elc' files into
190# the current directory, so disregarding the original directories used
191# in `.el' arguments.
192#
193# This script manages in such a way that all Emacs LISP files to
194# be compiled are made visible between themselves, in the event
195# they require or load-library one another.
196
197 if test $# = 0; then
198 exit 1
199 else
200 if test -z "${EMACS}" || test "${EMACS}" = "t"; then
201 # Value of "t" means we are running in a shell under Emacs.
202 # Just assume Emacs is called "emacs".
203 EMACS=emacs
204 fi
205
206 tempdir=elc.$$
207 mkdir ${tempdir}
208 cp $* ${tempdir}
209 cd ${tempdir}
210
211 echo "(add-to-list 'load-path \"../\")" > script
212 ${EMACS} -batch -q --no-site-file --no-init-file -l script -f batch-byte-compile *.el
213 mv *.elc ..
214
215 cd ..
216 rm -fr ${tempdir}
217 fi
218} 125}

Legend:
Removed from v.1.17  
changed lines
  Added in v.1.40

  ViewVC Help
Powered by ViewVC 1.1.20