/[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.48
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.48 2008/10/05 13:56:08 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. The case of interdependent
37# elisp files is also supported, since the current directory is added to the
38# load-path which makes sure that all files are loadable.
39#
40# elisp-compile *.el || die "elisp-compile failed"
41#
42# Formerly, function elisp-comp() was used for compilation of interdependent
43# elisp files. This usage is considered as obsolete.
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# @ECLASS-VARIABLE: SITEETC
136# @DESCRIPTION:
137# Directory where packages install miscellaneous (not Lisp) files.
138SITEETC=/usr/share/emacs/etc
139
140# @ECLASS-VARIABLE: SITEFILE
141# @DESCRIPTION:
142# Name of package's site-init file.
143SITEFILE=50${PN}-gentoo.el
144
145# @ECLASS-VARIABLE: EMACS
146# @DESCRIPTION:
147# Path of Emacs executable.
148EMACS=/usr/bin/emacs
149
150# @ECLASS-VARIABLE: EMACSFLAGS
151# @DESCRIPTION:
152# Flags for executing Emacs in batch mode.
153# These work for Emacs versions 18-23, so don't change them.
154EMACSFLAGS="-batch -q --no-site-file"
155
156# @ECLASS-VARIABLE: BYTECOMPFLAGS
157# @DESCRIPTION:
158# Emacs flags used for byte-compilation in elisp-compile().
159BYTECOMPFLAGS="-L ."
160
161# @FUNCTION: elisp-compile
162# @USAGE: <list of elisp files>
163# @DESCRIPTION:
164# Byte-compile Emacs Lisp files.
165#
166# This function uses GNU Emacs to byte-compile all ".el" specified by its
167# arguments. The resulting byte-code (".elc") files are placed in the same
168# directory as their corresponding source file.
169#
170# The current directory is added to the load-path. This will ensure that
171# interdependent Emacs Lisp files are visible between themselves, in case
172# they require or load one another.
173
15elisp-compile() { 174elisp-compile() {
16 /usr/bin/emacs --batch -f batch-byte-compile --no-site-file --no-init-file $* 175 ebegin "Compiling GNU Emacs Elisp files"
176 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
177 eend $? "batch-byte-compile failed"
17} 178}
179
180# #FUNCTION: elisp-comp
181# #USAGE: <list of elisp files>
182# #DESCRIPTION:
183# Byte-compile interdependent Emacs Lisp files.
184# THIS FUNCTION IS DEPRECATED.
185#
186# This function byte-compiles all ".el" files which are part of its
187# arguments, using GNU Emacs, and puts the resulting ".elc" files into the
188# current directory, so disregarding the original directories used in ".el"
189# arguments.
190#
191# This function manages in such a way that all Emacs Lisp files to be
192# compiled are made visible between themselves, in the event they require or
193# load one another.
194
195elisp-comp() {
196 # Copyright 1995 Free Software Foundation, Inc.
197 # François Pinard <pinard@iro.umontreal.ca>, 1995.
198 # Originally taken from GNU autotools.
199
200 ewarn "Function elisp-comp is deprecated and may be removed in future."
201 ewarn "Please use function elisp-compile instead, or report a bug about"
202 ewarn "${CATEGORY}/${PF} at <http://bugs.gentoo.org/>."
203 echo
204
205 [ $# -gt 0 ] || return 1
206
207 ebegin "Compiling GNU Emacs Elisp files"
208
209 local tempdir=elc.$$
210 mkdir ${tempdir}
211 cp "$@" ${tempdir}
212 pushd ${tempdir}
213
214 echo "(add-to-list 'load-path \"../\")" > script
215 ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el
216 local ret=$?
217 mv *.elc ..
218
219 popd
220 rm -fr ${tempdir}
221
222 eend ${ret} "batch-byte-compile failed"
223 return ${ret}
224}
225
226# @FUNCTION: elisp-emacs-version
227# @DESCRIPTION:
228# Output version of currently active Emacs.
229
230elisp-emacs-version() {
231 # The following will work for at least versions 18-23.
232 echo "(princ emacs-version)" >"${T}"/emacs-version.el
233 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
234 rm -f "${T}"/emacs-version.el
235}
236
237# @FUNCTION: elisp-make-autoload-file
238# @USAGE: [output file] [list of directories]
239# @DESCRIPTION:
240# Generate a file with autoload definitions for the lisp functions.
241
242elisp-make-autoload-file() {
243 local f="${1:-${PN}-autoloads.el}"
244 shift
245 ebegin "Generating autoload file for GNU Emacs"
246
247 sed 's/^FF/\f/' >"${f}" <<-EOF
248 ;;; ${f##*/} --- autoloads for ${P}
249
250 ;;; Commentary:
251 ;; Automatically generated by elisp-common.eclass
252 ;; DO NOT EDIT THIS FILE
253
254 ;;; Code:
255 FF
256 ;; Local Variables:
257 ;; version-control: never
258 ;; no-byte-compile: t
259 ;; no-update-autoloads: t
260 ;; End:
261 ;;; ${f##*/} ends here
262 EOF
263
264 ${EMACS} ${EMACSFLAGS} \
265 --eval "(setq make-backup-files nil)" \
266 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
267 -f batch-update-autoloads "${@-.}"
268
269 eend $? "batch-update-autoloads failed"
270}
271
272# @FUNCTION: elisp-install
273# @USAGE: <subdirectory> <list of files>
274# @DESCRIPTION:
275# Install files in SITELISP directory.
18 276
19elisp-install() { 277elisp-install() {
20 local subdir=$1 278 local subdir="$1"
21 dodir ${SITELISP}/${subdir}
22 insinto ${SITELISP}/${subdir}
23 shift 279 shift
280 ebegin "Installing Elisp files for GNU Emacs support"
281 ( # subshell to avoid pollution of calling environment
282 insinto "${SITELISP}/${subdir}"
24 doins $@ 283 doins "$@"
284 )
285 eend $? "doins failed"
25} 286}
287
288# @FUNCTION: elisp-site-file-install
289# @USAGE: <site-init file> [subdirectory]
290# @DESCRIPTION:
291# Install Emacs site-init file in SITELISP directory.
26 292
27elisp-site-file-install() { 293elisp-site-file-install() {
28 local sitefile=$1 my_pn=${2:-${PN}} 294 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
29 pushd ${S} 295 ebegin "Installing site initialisation file for GNU Emacs"
30 cp ${sitefile} ${T} 296 cp "$1" "${sf}"
31 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" ${T}/$(basename ${sitefile}) 297 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
32 insinto ${SITELISP} 298 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}"
33 doins ${T}/$(basename ${sitefile}) || die "failed to install site file" 299 ( # subshell to avoid pollution of calling environment
34 popd 300 insinto "${SITELISP}/site-gentoo.d"
301 doins "${sf}"
302 )
303 ret=$?
304 rm -f "${sf}"
305 eend ${ret} "doins failed"
35} 306}
307
308# @FUNCTION: elisp-site-regen
309# @DESCRIPTION:
310# Regenerate the site-gentoo.el file, based on packages' site initialisation
311# files in the /usr/share/emacs/site-lisp/site-gentoo.d/ directory.
312#
313# Note: Before December 2007, site initialisation files were installed in
314# /usr/share/emacs/site-lisp/. For backwards compatibility, this location is
315# still supported when generating site-gentoo.el.
36 316
37elisp-site-regen() { 317elisp-site-regen() {
318 local i sf line firstrun obsolete
319 local -a sflist
320 # Work around Paludis borkage: variable T is empty in pkg_postrm
321 local tmpdir=${T:-$(mktemp -d)}
322
323 if [ ! -d "${ROOT}${SITELISP}" ]; then
324 eerror "Directory ${SITELISP} does not exist"
325 return 1
326 fi
327
328 [ -e "${ROOT}${SITELISP}"/site-gentoo.el ] || firstrun=t
329
330 if [ "${firstrun}" ] && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
331 einfo "Creating default ${SITELISP}/site-start.el ..."
332 cat <<-EOF >"${tmpdir}"/site-start.el
333 ;;; site-start.el
334
335 ;;; Commentary:
336 ;; This default site startup file is installed by elisp-common.eclass.
337 ;; You may replace this file by your own site initialisation, or even
338 ;; remove it completely; it will not be recreated.
339
340 ;;; Code:
341 ;; Load site initialisation for Gentoo-installed packages.
342 (require 'site-gentoo)
343
344 ;;; site-start.el ends here
345 EOF
346 fi
347
38 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 348 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
39 einfo ""
40 cat <<EOF >${SITELISP}/site-gentoo.el
41;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE
42;;; -----------------------------------------------------------------
43 349
44EOF 350 # remove any auxiliary file (from previous run)
45 ls ${SITELISP}/[0-9][0-9]*-gentoo.el |sort -n | \ 351 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
46 while read sf 352
353 # set nullglob option, there may be a directory without matching files
354 local old_shopts=$(shopt -p nullglob)
355 shopt -s nullglob
356
357 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
358 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
47 do 359 do
48 einfo " Adding $(basename $sf) ..." 360 [ -r "${sf}" ] || continue
49 # Great for debugging, too noisy and slow for users though 361 # sort files by their basename. straight insertion sort.
50# echo "(message \"Loading $sf ...\")" >>${SITELISP}/site-start.el 362 for ((i=${#sflist[@]}; i>0; i--)); do
51 cat $sf >>${SITELISP}/site-gentoo.el 363 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
364 sflist[i]=${sflist[i-1]}
365 done
366 sflist[i]=${sf}
367 # set a flag if there are obsolete files
368 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
52 done 369 done
53 while read line; do einfo "${line}"; done <<EOF
54 370
55All site initialization for Gentoo-installed packages is now added to 371 eval "${old_shopts}"
56/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
57managed by Gentoo. You are responsible for all maintenance of
58site-start.el if there is such a file.
59 372
60In order for this site initialization to be loaded for all users 373 cat <<-EOF >"${tmpdir}"/site-gentoo.el
61automatically, as was done previously, you can add a line like this: 374 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
62 375
63 (load "/usr/share/emacs/site-lisp/site-gentoo") 376 ;;; Commentary:
377 ;; Automatically generated by elisp-common.eclass
378 ;; DO NOT EDIT THIS FILE
64 379
65to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 380 ;;; Code:
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 381 EOF
70 echo 382 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
71} 383 cat <<-EOF >>"${tmpdir}"/site-gentoo.el
72 384
73# The following Emacs Lisp compilation routine is taken from GNU 385 (provide 'site-gentoo)
74# autotools.
75 386
76elisp-comp() { 387 ;; Local Variables:
77# Copyright 1995 Free Software Foundation, Inc. 388 ;; no-byte-compile: t
78# François Pinard <pinard@iro.umontreal.ca>, 1995. 389 ;; End:
79# 390 ;;; site-gentoo.el ends here
80# This program is free software; you can redistribute it and/or modify 391 EOF
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 392
94# As a special exception to the GNU General Public License, if you 393 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el
95# distribute this file as part of a program that contains a 394 then
96# configuration script generated by Autoconf, you may include it under 395 # This prevents outputting unnecessary text when there
97# the same distribution terms that you use for the rest of that program. 396 # was actually no change.
98 397 # A case is a remerge where we have doubled output.
99# This script byte-compiles all `.el' files which are part of its 398 echo " no changes."
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 399 else
112 if test -z "$EMACS" || test "$EMACS" = "t"; then 400 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
113 # Value of "t" means we are running in a shell under Emacs. 401 [ -f "${tmpdir}"/site-start.el ] \
114 # Just assume Emacs is called "emacs". 402 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
115 EMACS=emacs 403 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
116 fi 404 echo
117 405 einfo "... ${#sflist[@]} site initialisation file(s) included."
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 406 fi
130}
131 407
132# Local Variables: *** 408 if [ "${firstrun}" ]; then
133# mode: shell-script *** 409 echo
134# tab-width: 4 *** 410 while read line; do einfo "${line:- }"; done <<-EOF
135# indent-tabs-mode: t *** 411 All site initialisation for Gentoo-installed packages is added to
136# End: *** 412 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is not
413 managed by Gentoo. You are responsible for all maintenance of
414 site-start.el if there is such a file.
137 415
416 In order for this site initialisation to be loaded for all users
417 automatically, you can add a line like this:
418
419 (require 'site-gentoo)
420
421 to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
422 can be added by individual users to their initialisation files, or,
423 for greater flexibility, users can load individual package-specific
424 initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
425 EOF
426 echo
427 fi
428
429 if [ "${obsolete}" ]; then
430 echo
431 while read line; do ewarn "${line}"; done <<-EOF
432 Site-initialisation files of Emacs packages are now installed in
433 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
434 that you use app-admin/emacs-updater to rebuild the installed
435 Emacs packages.
436 EOF
437
438 # Kludge for backwards compatibility: During pkg_postrm, old versions
439 # of this eclass (saved in the VDB) won't find packages' site-init
440 # files in the new location. So we copy them to an auxiliary file
441 # that is visible to old eclass versions.
442 for sf in "${sflist[@]}"; do
443 [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
444 && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
445 done
446 fi
447
448 # cleanup
449 rm -f "${tmpdir}"/site-{gentoo,start}.el
450
451 return 0
452}

Legend:
Removed from v.1.11  
changed lines
  Added in v.1.48

  ViewVC Help
Powered by ViewVC 1.1.20