/[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.52 Revision 1.58
1# Copyright 1999-2008 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-common.eclass,v 1.52 2008/11/24 14:21:04 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.58 2009/03/26 14:14:22 ulm Exp $
4# 4#
5# Copyright 2002-2004 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> 7# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
8# Copyright 2007-2008 Christian Faulhammer <opfer@gentoo.org> 8# Copyright 2007-2008 Christian Faulhammer <fauli@gentoo.org>
9# Copyright 2007-2008 Ulrich Müller <ulm@gentoo.org> 9# Copyright 2007-2009 Ulrich Müller <ulm@gentoo.org>
10# 10#
11# @ECLASS: elisp-common.eclass 11# @ECLASS: elisp-common.eclass
12# @MAINTAINER: 12# @MAINTAINER:
13# Feel free to contact the Emacs team through <emacs@gentoo.org> if you have 13# Feel free to contact the Emacs team through <emacs@gentoo.org> if you
14# problems, suggestions or questions. 14# have problems, suggestions or questions.
15# @BLURB: Emacs-related installation utilities 15# @BLURB: Emacs-related installation utilities
16# @DESCRIPTION: 16# @DESCRIPTION:
17# 17#
18# Usually you want to use this eclass for (optional) GNU Emacs support of 18# Usually you want to use this eclass for (optional) GNU Emacs support
19# your package. This is NOT for XEmacs! 19# of your package. This is NOT for XEmacs!
20# 20#
21# Many of the steps here are sometimes done by the build system of your 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 22# package (especially compilation), so this is mainly for standalone
23# files you gathered from somewhere else. 23# elisp files you gathered from somewhere else.
24# 24#
25# When relying on the emacs USE flag, you need to add 25# When relying on the emacs USE flag, you need to add
26# 26#
27# emacs? ( virtual/emacs ) 27# emacs? ( virtual/emacs )
28# 28#
29# to your DEPEND/RDEPEND line and use the functions provided here to bring 29# to your DEPEND/RDEPEND line and use the functions provided here to
30# the files to the correct locations. 30# bring the files to the correct locations.
31# 31#
32# .SS 32# .SS
33# src_compile() usage: 33# src_compile() usage:
34# 34#
35# An elisp file is compiled by the elisp-compile() function defined here and 35# An elisp file is compiled by the elisp-compile() function defined
36# simply takes the source files as arguments. The case of interdependent 36# here and simply takes the source files as arguments. The case of
37# elisp files is also supported, since the current directory is added to the 37# interdependent elisp files is also supported, since the current
38# load-path which makes sure that all files are loadable. 38# directory is added to the load-path which makes sure that all files
39# are loadable.
39# 40#
40# elisp-compile *.el || die 41# elisp-compile *.el || die
41# 42#
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 43# Function elisp-make-autoload-file() can be used to generate a file
46# autoload definitions for the lisp functions. It takes the output file name 44# with autoload definitions for the lisp functions. It takes the output
47# (default: "${PN}-autoloads.el") and a list of directories (default: working 45# file name (default: "${PN}-autoloads.el") and a list of directories
48# directory) as its arguments. Use of this function requires that the elisp 46# (default: working directory) as its arguments. Use of this function
49# source files contain magic ";;;###autoload" comments. See the Emacs Lisp 47# requires that the elisp source files contain magic ";;;###autoload"
50# Reference Manual (node "Autoload") for a detailed explanation. 48# comments. See the Emacs Lisp Reference Manual (node "Autoload") for
49# a detailed explanation.
51# 50#
52# .SS 51# .SS
53# src_install() usage: 52# src_install() usage:
54# 53#
55# The resulting compiled files (.elc) should be put in a subdirectory of 54# 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 55# /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 56# of elisp-install(). The following parameters are the files to be put
58# that directory. Usually the subdirectory should be ${PN}, you can choose 57# in that directory. Usually the subdirectory should be ${PN}, you can
59# something else, but remember to tell elisp-site-file-install() (see below) 58# choose something else, but remember to tell elisp-site-file-install()
60# the change, as it defaults to ${PN}. 59# (see below) the change, as it defaults to ${PN}.
61# 60#
62# elisp-install ${PN} *.el *.elc || die 61# elisp-install ${PN} *.el *.elc || die
63# 62#
64# To let the Emacs support be activated by Emacs on startup, you need 63# 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 64# to provide a site file (shipped in ${FILESDIR}) which contains the
66# code (have a look in the documentation of your software). Normally this 65# startup code (have a look in the documentation of your software).
67# would look like this: 66# Normally this would look like this:
68# 67#
69# ;;; csv-mode site-lisp configuration 68# ;;; csv-mode site-lisp configuration
70# 69#
71# (add-to-list 'load-path "@SITELISP@") 70# (add-to-list 'load-path "@SITELISP@")
72# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) 71# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
73# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t) 72# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
74# 73#
75# If your Emacs support files are installed in a subdirectory of 74# If your Emacs support files are installed in a subdirectory of
76# /usr/share/emacs/site-lisp/ (which is recommended), you need to extend 75# /usr/share/emacs/site-lisp/ (which is strongly recommended), you need
77# Emacs' load-path as shown in the first non-comment. 76# to extend Emacs' load-path as shown in the first non-comment line.
78# The elisp-site-file-install() function of this eclass will replace 77# The elisp-site-file-install() function of this eclass will replace
79# "@SITELISP@" by the actual path. 78# "@SITELISP@" and "@SITEETC@" by the actual paths.
80# 79#
81# The next line tells Emacs to load the mode opening a file ending with 80# The next line tells Emacs to load the mode opening a file ending
82# ".csv" and load functions depending on the context and needed features. 81# with ".csv" and load functions depending on the context and needed
83# Be careful though. Commands as "load-library" or "require" bloat the 82# features. Be careful though. Commands as "load-library" or "require"
84# editor as they are loaded on every startup. When having a lot of Emacs 83# bloat the editor as they are loaded on every startup. When having
85# support files, users may be annoyed by the start-up time. Also avoid 84# many Emacs support files, users may be annoyed by the start-up time.
86# keybindings as they might interfere with the user's settings. Give a hint 85# Also avoid keybindings as they might interfere with the user's
87# in pkg_postinst(), which should be enough. 86# settings. Give a hint in pkg_postinst(), which should be enough.
88# 87#
89# The naming scheme for this site-init file matches the shell pattern 88# The naming scheme for this site-init file matches the shell pattern
90# "[1-8][0-9]*-gentoo.el", where the two digits at the beginning define the 89# "[1-8][0-9]*-gentoo.el", where the two digits at the beginning define
91# loading order (numbers below 10 or above 89 are reserved for internal use). 90# the loading order (numbers below 10 or above 89 are reserved for
92# So if you depend on another Emacs package, your site file's number must be 91# internal use). So if your initialisation depends on another Emacs
93# higher! 92# package, your site file's number must be higher!
94# 93#
95# Best practice is to define a SITEFILE variable in the global scope of your 94# Best practice is to define a SITEFILE variable in the global scope of
96# ebuild (e.g., right after DEPEND): 95# your ebuild (e.g., right after S or RDEPEND):
97# 96#
98# SITEFILE=50${PN}-gentoo.el 97# SITEFILE="50${PN}-gentoo.el"
99# 98#
100# Which is then installed by 99# Which is then installed by
101# 100#
102# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die 101# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
103# 102#
… …
105# differing name as second argument. 104# differing name as second argument.
106# 105#
107# .SS 106# .SS
108# pkg_postinst() / pkg_postrm() usage: 107# pkg_postinst() / pkg_postrm() usage:
109# 108#
110# After that you need to recreate the start-up file of Emacs after emerging 109# After that you need to recreate the start-up file of Emacs after
111# and unmerging by using 110# emerging and unmerging by using
112# 111#
113# pkg_postinst() { 112# pkg_postinst() {
114# elisp-site-regen 113# elisp-site-regen
115# } 114# }
116# 115#
117# pkg_postrm() { 116# pkg_postrm() {
118# elisp-site-regen 117# elisp-site-regen
119# } 118# }
120# 119#
121# When having optional Emacs support, you should prepend "use emacs &&" to 120# When having optional Emacs support, you should prepend "use emacs &&"
122# above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"! 121# to above calls of elisp-site-regen().
123# When unmerging the state of the emacs USE flag is taken from the package 122# Don't use "has_version virtual/emacs"! When unmerging the state of
124# database and not from the environment, so it is no problem when you unset 123# the emacs USE flag is taken from the package database and not from the
124# environment, so it is no problem when you unset USE=emacs between
125# USE=emacs between merge and unmerge of a package. 125# merge and unmerge of a package.
126# 126#
127# .SS 127# .SS
128# Miscellaneous functions: 128# Miscellaneous functions:
129# 129#
130# elisp-emacs-version() outputs the version of the currently active Emacs. 130# elisp-emacs-version() outputs the version of the currently active Emacs.
… …
158# @FUNCTION: elisp-compile 158# @FUNCTION: elisp-compile
159# @USAGE: <list of elisp files> 159# @USAGE: <list of elisp files>
160# @DESCRIPTION: 160# @DESCRIPTION:
161# Byte-compile Emacs Lisp files. 161# Byte-compile Emacs Lisp files.
162# 162#
163# This function uses GNU Emacs to byte-compile all ".el" specified by its 163# This function uses GNU Emacs to byte-compile all ".el" specified by
164# arguments. The resulting byte-code (".elc") files are placed in the same 164# its arguments. The resulting byte-code (".elc") files are placed in
165# directory as their corresponding source file. 165# the same directory as their corresponding source file.
166# 166#
167# The current directory is added to the load-path. This will ensure that 167# The current directory is added to the load-path. This will ensure
168# interdependent Emacs Lisp files are visible between themselves, in case 168# that interdependent Emacs Lisp files are visible between themselves,
169# they require or load one another. 169# in case they require or load one another.
170 170
171elisp-compile() { 171elisp-compile() {
172 ebegin "Compiling GNU Emacs Elisp files" 172 ebegin "Compiling GNU Emacs Elisp files"
173 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@" 173 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
174 eend $? "elisp-compile: batch-byte-compile failed" 174 eend $? "elisp-compile: batch-byte-compile failed"
175} 175}
176 176
177# #FUNCTION: elisp-comp
178# #USAGE: <list of elisp files>
179# #DESCRIPTION:
180# Byte-compile interdependent Emacs Lisp files.
181# THIS FUNCTION IS DEPRECATED.
182#
183# This function byte-compiles all ".el" files which are part of its
184# arguments, using GNU Emacs, and puts the resulting ".elc" files into the
185# current directory, so disregarding the original directories used in ".el"
186# arguments.
187#
188# This function manages in such a way that all Emacs Lisp files to be
189# compiled are made visible between themselves, in the event they require or
190# load one another.
191
192elisp-comp() { 177elisp-comp() {
193 # Copyright 1995 Free Software Foundation, Inc. 178 die "Function elisp-comp is not supported any more, see bug 235442"
194 # François Pinard <pinard@iro.umontreal.ca>, 1995.
195 # Originally taken from GNU autotools.
196
197 ewarn "Function elisp-comp is deprecated and may be removed in future."
198 ewarn "Please use function elisp-compile instead, or report a bug about"
199 ewarn "${CATEGORY}/${PF} at <http://bugs.gentoo.org/>."
200 echo
201
202 [ $# -gt 0 ] || return 1
203
204 ebegin "Compiling GNU Emacs Elisp files"
205
206 local tempdir=elc.$$
207 mkdir ${tempdir}
208 cp "$@" ${tempdir}
209 pushd ${tempdir}
210
211 echo "(add-to-list 'load-path \"../\")" > script
212 ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el
213 local ret=$?
214 mv *.elc ..
215
216 popd
217 rm -fr ${tempdir}
218
219 eend ${ret} "elisp-comp: batch-byte-compile failed"
220} 179}
221 180
222# @FUNCTION: elisp-emacs-version 181# @FUNCTION: elisp-emacs-version
223# @DESCRIPTION: 182# @DESCRIPTION:
224# Output version of currently active Emacs. 183# Output version of currently active Emacs.
… …
301 eend ${ret} "elisp-site-file-install: doins failed" 260 eend ${ret} "elisp-site-file-install: doins failed"
302} 261}
303 262
304# @FUNCTION: elisp-site-regen 263# @FUNCTION: elisp-site-regen
305# @DESCRIPTION: 264# @DESCRIPTION:
306# Regenerate the site-gentoo.el file, based on packages' site initialisation 265# Regenerate the site-gentoo.el file, based on packages' site
307# files in the /usr/share/emacs/site-lisp/site-gentoo.d/ directory. 266# initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
267# directory.
308# 268#
309# Note: Before December 2007, site initialisation files were installed in 269# Note: Before December 2007, site initialisation files were installed
310# /usr/share/emacs/site-lisp/. For backwards compatibility, this location is 270# in /usr/share/emacs/site-lisp/. For backwards compatibility, this
311# still supported when generating site-gentoo.el. 271# location is still supported when generating site-gentoo.el.
312 272
313elisp-site-regen() { 273elisp-site-regen() {
314 local i sf line firstrun obsolete 274 local i sf line firstrun obsolete
315 local -a sflist 275 local -a sflist
316 # Work around Paludis borkage: variable T is empty in pkg_postrm
317 local tmpdir=${T:-$(mktemp -d)}
318 276
319 if [ ! -d "${ROOT}${SITELISP}" ]; then 277 if [ ! -d "${ROOT}${SITELISP}" ]; then
320 eerror "elisp-site-regen: Directory ${SITELISP} does not exist" 278 eerror "elisp-site-regen: Directory ${SITELISP} does not exist"
321 return 1 279 return 1
322 fi 280 fi
323 281
282 if [ ! -d "${T}" ]; then
283 eerror "elisp-site-regen: Temporary directory ${T} does not exist"
284 return 1
285 fi
286
324 [ -e "${ROOT}${SITELISP}"/site-gentoo.el ] || firstrun=t 287 [ -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
288 || [ "${PN}" = emacs-common-gentoo ] || firstrun=t
325 289
326 if [ "${firstrun}" ] && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then 290 if [ "${firstrun}" ] && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
327 einfo "Creating default ${SITELISP}/site-start.el ..." 291 einfo "Creating default site-start.el ..."
328 cat <<-EOF >"${tmpdir}"/site-start.el 292 cat <<-EOF >"${T}"/site-start.el
329 ;;; site-start.el 293 ;;; site-start.el
330 294
331 ;;; Commentary: 295 ;;; Commentary:
332 ;; This default site startup file is installed by elisp-common.eclass. 296 ;; This default site startup file is installed by elisp-common.eclass.
333 ;; You may replace this file by your own site initialisation, or even 297 ;; You may replace this file by your own site initialisation, or even
… …
339 303
340 ;;; site-start.el ends here 304 ;;; site-start.el ends here
341 EOF 305 EOF
342 fi 306 fi
343 307
344 einfon "Regenerating ${SITELISP}/site-gentoo.el ..." 308 einfon "Regenerating site-gentoo.el (${EBUILD_PHASE}) ..."
345 309
346 # remove any auxiliary file (from previous run) 310 # Until January 2009, elisp-common.eclass sometimes created an
311 # auxiliary file for backwards compatibility. Remove any such file.
347 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el 312 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
348 313
349 # set nullglob option, there may be a directory without matching files 314 # set nullglob option, there may be a directory without matching files
350 local old_shopts=$(shopt -p nullglob) 315 local old_shopts=$(shopt -p nullglob)
351 shopt -s nullglob 316 shopt -s nullglob
… …
364 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t 329 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
365 done 330 done
366 331
367 eval "${old_shopts}" 332 eval "${old_shopts}"
368 333
369 cat <<-EOF >"${tmpdir}"/site-gentoo.el 334 cat <<-EOF >"${T}"/site-gentoo.el
370 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages 335 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
371 336
372 ;;; Commentary: 337 ;;; Commentary:
373 ;; Automatically generated by elisp-common.eclass 338 ;; Automatically generated by elisp-common.eclass
374 ;; DO NOT EDIT THIS FILE 339 ;; DO NOT EDIT THIS FILE
375 340
376 ;;; Code: 341 ;;; Code:
377 EOF 342 EOF
378 # Use sed instead of cat here, since files may miss a trailing newline. 343 # Use sed instead of cat here, since files may miss a trailing newline.
379 sed '$q' "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el 344 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
380 cat <<-EOF >>"${tmpdir}"/site-gentoo.el 345 cat <<-EOF >>"${T}"/site-gentoo.el
381 346
382 (provide 'site-gentoo) 347 (provide 'site-gentoo)
383 348
384 ;; Local Variables: 349 ;; Local Variables:
385 ;; no-byte-compile: t 350 ;; no-byte-compile: t
386 ;; End: 351 ;; End:
387 ;;; site-gentoo.el ends here 352 ;;; site-gentoo.el ends here
388 EOF 353 EOF
389 354
390 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el 355 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el
391 then 356 then
392 # This prevents outputting unnecessary text when there 357 # This prevents outputting unnecessary text when there
393 # was actually no change. 358 # was actually no change.
394 # A case is a remerge where we have doubled output. 359 # A case is a remerge where we have doubled output.
395 echo " no changes." 360 echo " no changes."
396 else 361 else
397 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el 362 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
398 [ -f "${tmpdir}"/site-start.el ] \ 363 [ -f "${T}"/site-start.el ] \
399 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \ 364 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
400 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el 365 && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
401 echo 366 echo
402 einfo "... ${#sflist[@]} site initialisation file(s) included." 367 einfo "... ${#sflist[@]} site initialisation file(s) included."
403 fi 368 fi
404 369
405 if [ "${firstrun}" ]; then 370 if [ "${firstrun}" ]; then
… …
429 Site-initialisation files of Emacs packages are now installed in 394 Site-initialisation files of Emacs packages are now installed in
430 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend 395 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
431 that you use app-admin/emacs-updater to rebuild the installed 396 that you use app-admin/emacs-updater to rebuild the installed
432 Emacs packages. 397 Emacs packages.
433 EOF 398 EOF
434
435 # Kludge for backwards compatibility: During pkg_postrm, old versions
436 # of this eclass (saved in the VDB) won't find packages' site-init
437 # files in the new location. So we copy them to an auxiliary file
438 # that is visible to old eclass versions.
439 for sf in "${sflist[@]}"; do
440 [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
441 && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
442 done
443 fi 399 fi
444 400
445 # cleanup 401 # cleanup
446 rm -f "${tmpdir}"/site-{gentoo,start}.el 402 rm -f "${T}"/site-{gentoo,start}.el
447 403
448 return 0 404 return 0
449} 405}
Legend:
Removed from v.1.52  
changed lines
  Added in v.1.58
  ViewVC Help
Powered by ViewVC 1.1.13