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

Diff of /eclass/elisp-common.eclass

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

Revision 1.11 Revision 1.38
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2008 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-common.eclass,v 1.11 2005/07/06 20:20:03 agriffis Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.38 2008/04/04 18:11:28 ulm Exp $
4# 4#
5# Copyright 2002-2003 Matthew Kennedy <mkennedy@gentoo.org> 5# Copyright 2002-2004 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 2004-2005 Mamoru Komachi <usata@gentoo.org>
8# Copyright 2007-2008 Christian Faulhammer <opfer@gentoo.org>
9# Copyright 2007-2008 Ulrich Müller <ulm@gentoo.org>
7# 10#
8# This is not an eclass, but it does provide emacs-related 11# @ECLASS: elisp-common.eclass
9# installation utilities. 12# @MAINTAINER:
13# Feel free to contact the Emacs team through <emacs@gentoo.org> if you have
14# problems, suggestions or questions.
15# @BLURB: Emacs-related installation utilities
16# @DESCRIPTION:
17#
18# Usually you want to use this eclass for (optional) GNU Emacs support of
19# your package. This is NOT for XEmacs!
20#
21# Many of the steps here are sometimes done by the build system of your
22# package (especially compilation), so this is mainly for standalone elisp
23# files you gathered from somewhere else.
24#
25# When relying on the emacs USE flag, you need to add
26#
27# emacs? ( virtual/emacs )
28#
29# to your DEPEND/RDEPEND line and use the functions provided here to bring
30# the files to the correct locations.
31#
32# .SS
33# src_compile() usage:
34#
35# An elisp file is compiled by the elisp-compile() function defined here and
36# simply takes the source files as arguments.
37#
38# elisp-compile *.el || die "elisp-compile failed"
39#
40# In the case of interdependent elisp files, you can use the elisp-comp()
41# function which makes sure all files are loadable.
42#
43# elisp-comp *.el || die "elisp-comp failed"
44#
45# Function elisp-make-autoload-file() can be used to generate a file with
46# autoload definitions for the lisp functions. It takes the output file name
47# (default: "${PN}-autoloads.el") and a list of directories (default: working
48# directory) as its arguments. Use of this function requires that the elisp
49# source files contain magic ";;;###autoload" comments. See the Emacs Lisp
50# Reference Manual (node "Autoload") for a detailed explanation.
51#
52# .SS
53# src_install() usage:
54#
55# The resulting compiled files (.elc) should be put in a subdirectory of
56# /usr/share/emacs/site-lisp/ which is named after the first argument
57# of elisp-install(). The following parameters are the files to be put in
58# that directory. Usually the subdirectory should be ${PN}, you can choose
59# something else, but remember to tell elisp-site-file-install() (see below)
60# the change, as it defaults to ${PN}.
61#
62# elisp-install ${PN} *.el *.elc || die "elisp-install failed"
63#
64# To let the Emacs support be activated by Emacs on startup, you need
65# to provide a site file (shipped in ${FILESDIR}) which contains the startup
66# code (have a look in the documentation of your software). Normally this
67# would look like this:
68#
69# ;;; csv-mode site-lisp configuration
70#
71# (add-to-list 'load-path "@SITELISP@")
72# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
73# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
74#
75# If your Emacs support files are installed in a subdirectory of
76# /usr/share/emacs/site-lisp/ (which is recommended), you need to extend
77# Emacs' load-path as shown in the first non-comment.
78# The elisp-site-file-install() function of this eclass will replace
79# "@SITELISP@" by the actual path.
80#
81# The next line tells Emacs to load the mode opening a file ending with
82# ".csv" and load functions depending on the context and needed features.
83# Be careful though. Commands as "load-library" or "require" bloat the
84# editor as they are loaded on every startup. When having a lot of Emacs
85# support files, users may be annoyed by the start-up time. Also avoid
86# keybindings as they might interfere with the user's settings. Give a hint
87# in pkg_postinst(), which should be enough.
88#
89# The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the
90# two digits at the beginning define the loading order. So if you depend on
91# another Emacs package, your site file's number must be higher!
92#
93# Best practice is to define a SITEFILE variable in the global scope of your
94# ebuild (right after DEPEND e.g.):
95#
96# SITEFILE=50${PN}-gentoo.el
97#
98# Which is then installed by
99#
100# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
101#
102# in src_install(). If your subdirectory is not named ${PN}, give the
103# differing name as second argument.
104#
105# .SS
106# pkg_postinst() / pkg_postrm() usage:
107#
108# After that you need to recreate the start-up file of Emacs after emerging
109# and unmerging by using
110#
111# pkg_postinst() {
112# elisp-site-regen
113# }
114#
115# pkg_postrm() {
116# elisp-site-regen
117# }
118#
119# When having optional Emacs support, you should prepend "use emacs &&" to
120# above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"!
121# When unmerging the state of the emacs USE flag is taken from the package
122# database and not from the environment, so it is no problem when you unset
123# USE=emacs between merge and unmerge of a package.
124#
125# .SS
126# Miscellaneous functions:
127#
128# elisp-emacs-version() outputs the version of the currently active Emacs.
10 129
11INHERITED="$INHERITED $ECLASS" 130# @ECLASS-VARIABLE: SITELISP
12 131# @DESCRIPTION:
132# Directory where packages install Emacs Lisp files.
13SITELISP=/usr/share/emacs/site-lisp 133SITELISP=/usr/share/emacs/site-lisp
14 134
135# Directory where packages install miscellaneous (not Lisp) files.
136SITEETC=/usr/share/emacs/etc
137
138# @ECLASS-VARIABLE: SITEFILE
139# @DESCRIPTION:
140# Name of package's site-init file.
141SITEFILE=50${PN}-gentoo.el
142
143EMACS=/usr/bin/emacs
144# The following works for Emacs versions 18-23, don't change it.
145EMACSFLAGS="-batch -q --no-site-file"
146
147# @FUNCTION: elisp-compile
148# @USAGE: <list of elisp files>
149# @DESCRIPTION:
150# Byte-compile Emacs Lisp files.
151
15elisp-compile() { 152elisp-compile() {
16 /usr/bin/emacs --batch -f batch-byte-compile --no-site-file --no-init-file $* 153 ebegin "Compiling GNU Emacs Elisp files"
154 ${EMACS} ${EMACSFLAGS} -f batch-byte-compile "$@"
155 eend $? "batch-byte-compile failed"
17} 156}
157
158# @FUNCTION: elisp-comp
159# @USAGE: <list of elisp files>
160# @DESCRIPTION:
161# Byte-compile interdependent Emacs Lisp files.
162#
163# This function byte-compiles all ".el" files which are part of its
164# arguments, using GNU Emacs, and puts the resulting ".elc" files into the
165# current directory, so disregarding the original directories used in ".el"
166# arguments.
167#
168# This function manages in such a way that all Emacs Lisp files to be
169# compiled are made visible between themselves, in the event they require or
170# load one another.
171
172elisp-comp() {
173 # Copyright 1995 Free Software Foundation, Inc.
174 # François Pinard <pinard@iro.umontreal.ca>, 1995.
175 # Originally taken from GNU autotools.
176
177 [ $# -gt 0 ] || return 1
178
179 ebegin "Compiling GNU Emacs Elisp files"
180
181 tempdir=elc.$$
182 mkdir ${tempdir}
183 cp "$@" ${tempdir}
184 pushd ${tempdir}
185
186 echo "(add-to-list 'load-path \"../\")" > script
187 ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el
188 local ret=$?
189 mv *.elc ..
190
191 popd
192 rm -fr ${tempdir}
193
194 eend ${ret} "batch-byte-compile failed"
195 return ${ret}
196}
197
198# @FUNCTION: elisp-emacs-version
199# @DESCRIPTION:
200# Output version of currently active Emacs.
201
202elisp-emacs-version() {
203 # The following will work for at least versions 18-23.
204 echo "(princ emacs-version)" >"${T}"/emacs-version.el
205 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
206 rm -f "${T}"/emacs-version.el
207}
208
209# @FUNCTION: elisp-make-autoload-file
210# @USAGE: [output file] [list of directories]
211# @DESCRIPTION:
212# Generate a file with autoload definitions for the lisp functions.
213
214elisp-make-autoload-file() {
215 local f="${1:-${PN}-autoloads.el}"
216 shift
217 ebegin "Generating autoload file for GNU Emacs"
218
219 sed 's/^FF/\f/' >"${f}" <<-EOF
220 ;;; ${f##*/} --- autoloads for ${P}
221
222 ;;; Commentary:
223 ;; Automatically generated by elisp-common.eclass
224 ;; DO NOT EDIT THIS FILE
225
226 ;;; Code:
227 FF
228 ;; Local Variables:
229 ;; version-control: never
230 ;; no-byte-compile: t
231 ;; no-update-autoloads: t
232 ;; End:
233 ;;; ${f##*/} ends here
234 EOF
235
236 ${EMACS} ${EMACSFLAGS} \
237 --eval "(setq make-backup-files nil)" \
238 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
239 -f batch-update-autoloads "${@-.}"
240
241 eend $? "batch-update-autoloads failed"
242}
243
244# @FUNCTION: elisp-install
245# @USAGE: <subdirectory> <list of files>
246# @DESCRIPTION:
247# Install files in SITELISP directory.
18 248
19elisp-install() { 249elisp-install() {
20 local subdir=$1 250 local subdir="$1"
21 dodir ${SITELISP}/${subdir}
22 insinto ${SITELISP}/${subdir}
23 shift 251 shift
252 ebegin "Installing Elisp files for GNU Emacs support"
253 ( # subshell to avoid pollution of calling environment
254 insinto "${SITELISP}/${subdir}"
24 doins $@ 255 doins "$@"
256 )
257 eend $? "doins failed"
25} 258}
259
260# @FUNCTION: elisp-site-file-install
261# @USAGE: <site-init file> [subdirectory]
262# @DESCRIPTION:
263# Install Emacs site-init file in SITELISP directory.
26 264
27elisp-site-file-install() { 265elisp-site-file-install() {
28 local sitefile=$1 my_pn=${2:-${PN}} 266 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
29 pushd ${S} 267 ebegin "Installing site initialisation file for GNU Emacs"
30 cp ${sitefile} ${T} 268 cp "$1" "${sf}"
31 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" ${T}/$(basename ${sitefile}) 269 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
32 insinto ${SITELISP} 270 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}"
33 doins ${T}/$(basename ${sitefile}) || die "failed to install site file" 271 ( # subshell to avoid pollution of calling environment
34 popd 272 insinto "${SITELISP}/site-gentoo.d"
273 doins "${sf}"
274 )
275 ret=$?
276 rm -f "${sf}"
277 eend ${ret} "doins failed"
35} 278}
279
280# @FUNCTION: elisp-site-regen
281# @DESCRIPTION:
282# Regenerate site-gentoo.el file. The old location for site initialisation
283# files of packages was /usr/share/emacs/site-lisp/. In December 2007 this
284# has been changed to /usr/share/emacs/site-lisp/site-gentoo.d/. Remerge of
285# packages with Emacs support is enough, the old location is still supported
286# when generating the start-up file.
36 287
37elisp-site-regen() { 288elisp-site-regen() {
289 local i sf line obsolete
290 local -a sflist
291 # Work around Paludis borkage: variable T is empty in pkg_postrm
292 local tmpdir=${T:-/tmp}
293
294 if [ ! -d "${ROOT}${SITELISP}" ]; then
295 eerror "Directory ${SITELISP} does not exist"
296 return 1
297 fi
298
299 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
300 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
301 einfo "Creating default ${SITELISP}/site-start.el ..."
302 cat <<-EOF >"${tmpdir}"/site-start.el
303 ;;; site-start.el
304
305 ;;; Commentary:
306 ;; This default site startup file is installed by elisp-common.eclass.
307 ;; You may replace this file by your own site initialisation, or even
308 ;; remove it completely; it will not be recreated.
309
310 ;;; Code:
311 ;; Load site initialisation for Gentoo-installed packages.
312 (require 'site-gentoo)
313
314 ;;; site-start.el ends here
315 EOF
316 fi
317
38 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 318 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
39 einfo "" 319
320 # remove auxiliary file
321 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
322
323 # set nullglob option, there may be a directory without matching files
324 local old_shopts=$(shopt -p nullglob)
325 shopt -s nullglob
326
327 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
328 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
329 do
330 [ -r "${sf}" ] || continue
331 # sort files by their basename. straight insertion sort.
332 for ((i=${#sflist[@]}; i>0; i--)); do
333 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
334 sflist[i]=${sflist[i-1]}
335 done
336 sflist[i]=${sf}
337 # set a flag if there are obsolete files
338 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
339 done
340
341 eval "${old_shopts}"
342
40 cat <<EOF >${SITELISP}/site-gentoo.el 343 cat <<-EOF >"${tmpdir}"/site-gentoo.el
41;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE 344 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
42;;; -----------------------------------------------------------------
43 345
346 ;;; Commentary:
347 ;; Automatically generated by elisp-common.eclass
348 ;; DO NOT EDIT THIS FILE
349
350 ;;; Code:
351 EOF
352 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
353 cat <<-EOF >>"${tmpdir}"/site-gentoo.el
354
355 (provide 'site-gentoo)
356
357 ;; Local Variables:
358 ;; no-byte-compile: t
359 ;; End:
360 ;;; site-gentoo.el ends here
361 EOF
362
363 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el
364 then
365 # This prevents outputting unnecessary text when there
366 # was actually no change.
367 # A case is a remerge where we have doubled output.
368 echo " no changes."
369 else
370 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
371 [ -f "${tmpdir}"/site-start.el ] \
372 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
373 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
374 echo; einfo
375 for sf in "${sflist[@]##*/}"; do
376 einfo " Adding ${sf} ..."
377 done
378 einfo "Regenerated ${SITELISP}/site-gentoo.el."
379
380 echo
381 while read line; do einfo "${line}"; done <<EOF
382All site initialisation for Gentoo-installed packages is added to
383/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
384managed by Gentoo. You are responsible for all maintenance of
385site-start.el if there is such a file.
386
387In order for this site initialisation to be loaded for all users
388automatically, you can add a line like this:
389
390 (require 'site-gentoo)
391
392to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
393can be added by individual users to their initialisation files, or,
394for greater flexibility, users can load individual package-specific
395initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
44EOF 396EOF
45 ls ${SITELISP}/[0-9][0-9]*-gentoo.el |sort -n | \ 397 echo
46 while read sf 398
47 do 399 if [ "${obsolete}" ]; then
48 einfo " Adding $(basename $sf) ..." 400 while read line; do ewarn "${line}"; done <<-EOF
49 # Great for debugging, too noisy and slow for users though 401 Site-initialisation files of Emacs packages are now installed in
50# echo "(message \"Loading $sf ...\")" >>${SITELISP}/site-start.el 402 /usr/share/emacs/site-lisp/site-gentoo.d/. You may consider using
403 /usr/sbin/emacs-updater to rebuild the installed Emacs packages.
404 However, the old location is still supported.
405 EOF
406 echo
407 fi
408 fi
409
410 # Kludge for backwards compatibility: During pkg_postrm, old versions
411 # of this eclass (saved in the VDB) won't find packages' site-init files
412 # in the new location. So we copy them to an auxiliary file that is
413 # visible to old eclass versions.
414 for sf in "${sflist[@]}"; do
415 [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
51 cat $sf >>${SITELISP}/site-gentoo.el 416 && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
52 done 417 done
53 while read line; do einfo "${line}"; done <<EOF
54 418
55All site initialization for Gentoo-installed packages is now added to 419 # cleanup
56/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer 420 rm -f "${tmpdir}"/site-{gentoo,start}.el
57managed by Gentoo. You are responsible for all maintenance of
58site-start.el if there is such a file.
59
60In order for this site initialization to be loaded for all users
61automatically, as was done previously, you can add a line like this:
62
63 (load "/usr/share/emacs/site-lisp/site-gentoo")
64
65to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
66can be added by individual users to their initialization files, or for
67greater flexibility, users can select which of the package-specific
68initialization files in /usr/share/emacs/site-lisp to load.
69EOF
70 echo
71} 421}
72
73# The following Emacs Lisp compilation routine is taken from GNU
74# autotools.
75
76elisp-comp() {
77# Copyright 1995 Free Software Foundation, Inc.
78# François Pinard <pinard@iro.umontreal.ca>, 1995.
79#
80# This program is free software; you can redistribute it and/or modify
81# it under the terms of the GNU General Public License as published by
82# the Free Software Foundation; either version 2, or (at your option)
83# any later version.
84#
85# This program is distributed in the hope that it will be useful,
86# but WITHOUT ANY WARRANTY; without even the implied warranty of
87# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
88# GNU General Public License for more details.
89#
90# You should have received a copy of the GNU General Public License
91# along with this program; if not, write to the Free Software
92# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
93
94# As a special exception to the GNU General Public License, if you
95# distribute this file as part of a program that contains a
96# configuration script generated by Autoconf, you may include it under
97# the same distribution terms that you use for the rest of that program.
98
99# This script byte-compiles all `.el' files which are part of its
100# arguments, using GNU Emacs, and put the resulting `.elc' files into
101# the current directory, so disregarding the original directories used
102# in `.el' arguments.
103#
104# This script manages in such a way that all Emacs LISP files to
105# be compiled are made visible between themselves, in the event
106# they require or load-library one another.
107
108 if test $# = 0; then
109 echo 1>&2 "No files given to $0"
110 exit 1
111 else
112 if test -z "$EMACS" || test "$EMACS" = "t"; then
113 # Value of "t" means we are running in a shell under Emacs.
114 # Just assume Emacs is called "emacs".
115 EMACS=emacs
116 fi
117
118 tempdir=elc.$$
119 mkdir $tempdir
120 cp $* $tempdir
121 cd $tempdir
122
123 echo "(add-to-list 'load-path \"../\")" > script
124 $EMACS -batch -q --no-site-file --no-init-file -l script -f batch-byte-compile *.el
125 mv *.elc ..
126
127 cd ..
128 rm -fr $tempdir
129 fi
130}
131
132# Local Variables: ***
133# mode: shell-script ***
134# tab-width: 4 ***
135# indent-tabs-mode: t ***
136# End: ***
137
Legend:
Removed from v.1.11  
changed lines
  Added in v.1.38
  ViewVC Help
Powered by ViewVC 1.1.13