/[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.41 Revision 1.50
1# Copyright 1999-2008 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.41 2008/07/01 22:10:06 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.50 2008/10/16 09:28:58 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 <opfer@gentoo.org>
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 here and
36# simply takes the source files as arguments. 36# simply takes the source files as arguments. The case of interdependent
37# 37# elisp files is also supported, since the current directory is added to the
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. 38# load-path which makes sure that all files are loadable.
42# 39#
43# elisp-comp *.el || die "elisp-comp failed" 40# elisp-compile *.el || die
41#
42# Formerly, function elisp-comp() was used for compilation of interdependent
43# elisp files. This usage is considered as obsolete.
44# 44#
45# Function elisp-make-autoload-file() can be used to generate a file with 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 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 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 48# directory) as its arguments. Use of this function requires that the elisp
49# source files contain magic ";;;###autoload" comments. See the Emacs Lisp 49# source files contain magic ";;;###autoload" comments. See the Emacs Lisp
50# Reference Manual (node "Autoload") for a detailed explanation. 50# Reference Manual (node "Autoload") for a detailed explanation.
51# 51#
52# .SS 52# .SS
53# src_install() usage: 53# src_install() usage:
54# 54#
57# of elisp-install(). The following parameters are the files to be put in 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 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) 59# something else, but remember to tell elisp-site-file-install() (see below)
60# the change, as it defaults to ${PN}. 60# the change, as it defaults to ${PN}.
61# 61#
62# elisp-install ${PN} *.el *.elc || die "elisp-install failed" 62# elisp-install ${PN} *.el *.elc || die
63# 63#
64# To let the Emacs support be activated by Emacs on startup, you need 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 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 66# code (have a look in the documentation of your software). Normally this
67# would look like this: 67# would look like this:
84# editor as they are loaded on every startup. When having a lot of Emacs 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 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 86# keybindings as they might interfere with the user's settings. Give a hint
87# in pkg_postinst(), which should be enough. 87# in pkg_postinst(), which should be enough.
88# 88#
89# The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the 89# The naming scheme for this site-init file matches the shell pattern
90# two digits at the beginning define the loading order. So if you depend on 90# "[1-8][0-9]*-gentoo.el", where the two digits at the beginning define the
91# loading order (numbers below 10 or above 89 are reserved for internal use).
91# another Emacs package, your site file's number must be higher! 92# So if you depend on another Emacs package, your site file's number must be
93# higher!
92# 94#
93# Best practice is to define a SITEFILE variable in the global scope of your 95# Best practice is to define a SITEFILE variable in the global scope of your
94# ebuild (right after DEPEND e.g.): 96# ebuild (e.g., right after DEPEND):
95# 97#
96# SITEFILE=50${PN}-gentoo.el 98# SITEFILE=50${PN}-gentoo.el
97# 99#
98# Which is then installed by 100# Which is then installed by
99# 101#
130# @ECLASS-VARIABLE: SITELISP 132# @ECLASS-VARIABLE: SITELISP
131# @DESCRIPTION: 133# @DESCRIPTION:
132# Directory where packages install Emacs Lisp files. 134# Directory where packages install Emacs Lisp files.
133SITELISP=/usr/share/emacs/site-lisp 135SITELISP=/usr/share/emacs/site-lisp
134 136
137# @ECLASS-VARIABLE: SITEETC
138# @DESCRIPTION:
135# Directory where packages install miscellaneous (not Lisp) files. 139# Directory where packages install miscellaneous (not Lisp) files.
136SITEETC=/usr/share/emacs/etc 140SITEETC=/usr/share/emacs/etc
137 141
138# @ECLASS-VARIABLE: SITEFILE 142# @ECLASS-VARIABLE: SITEFILE
139# @DESCRIPTION: 143# @DESCRIPTION:
140# Name of package's site-init file. 144# Name of package's site-init file.
141SITEFILE=50${PN}-gentoo.el 145SITEFILE=50${PN}-gentoo.el
142 146
147# @ECLASS-VARIABLE: EMACS
148# @DESCRIPTION:
149# Path of Emacs executable.
143EMACS=/usr/bin/emacs 150EMACS=/usr/bin/emacs
151
152# @ECLASS-VARIABLE: EMACSFLAGS
153# @DESCRIPTION:
154# Flags for executing Emacs in batch mode.
144# The following works for Emacs versions 18-23, don't change it. 155# These work for Emacs versions 18-23, so don't change them.
145EMACSFLAGS="-batch -q --no-site-file" 156EMACSFLAGS="-batch -q --no-site-file"
157
158# @ECLASS-VARIABLE: BYTECOMPFLAGS
159# @DESCRIPTION:
160# Emacs flags used for byte-compilation in elisp-compile().
161BYTECOMPFLAGS="-L ."
146 162
147# @FUNCTION: elisp-compile 163# @FUNCTION: elisp-compile
148# @USAGE: <list of elisp files> 164# @USAGE: <list of elisp files>
149# @DESCRIPTION: 165# @DESCRIPTION:
150# Byte-compile Emacs Lisp files. 166# Byte-compile Emacs Lisp files.
167#
168# This function uses GNU Emacs to byte-compile all ".el" specified by its
169# arguments. The resulting byte-code (".elc") files are placed in the same
170# directory as their corresponding source file.
171#
172# The current directory is added to the load-path. This will ensure that
173# interdependent Emacs Lisp files are visible between themselves, in case
174# they require or load one another.
151 175
152elisp-compile() { 176elisp-compile() {
153 ebegin "Compiling GNU Emacs Elisp files" 177 ebegin "Compiling GNU Emacs Elisp files"
154 ${EMACS} ${EMACSFLAGS} -f batch-byte-compile "$@" 178 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
155 eend $? "batch-byte-compile failed" 179 eend $? "elisp-compile: batch-byte-compile failed"
156} 180}
157 181
158# @FUNCTION: elisp-comp 182# #FUNCTION: elisp-comp
159# @USAGE: <list of elisp files> 183# #USAGE: <list of elisp files>
160# @DESCRIPTION: 184# #DESCRIPTION:
161# Byte-compile interdependent Emacs Lisp files. 185# Byte-compile interdependent Emacs Lisp files.
186# THIS FUNCTION IS DEPRECATED.
162# 187#
163# This function byte-compiles all ".el" files which are part of its 188# 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 189# arguments, using GNU Emacs, and puts the resulting ".elc" files into the
165# current directory, so disregarding the original directories used in ".el" 190# current directory, so disregarding the original directories used in ".el"
166# arguments. 191# arguments.
172elisp-comp() { 197elisp-comp() {
173 # Copyright 1995 Free Software Foundation, Inc. 198 # Copyright 1995 Free Software Foundation, Inc.
174 # Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995. 199 # Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995.
175 # Originally taken from GNU autotools. 200 # Originally taken from GNU autotools.
176 201
202 ewarn "Function elisp-comp is deprecated and may be removed in future."
203 ewarn "Please use function elisp-compile instead, or report a bug about"
204 ewarn "${CATEGORY}/${PF} at <http://bugs.gentoo.org/>."
205 echo
206
177 [ $# -gt 0 ] || return 1 207 [ $# -gt 0 ] || return 1
178 208
179 ebegin "Compiling GNU Emacs Elisp files" 209 ebegin "Compiling GNU Emacs Elisp files"
180 210
181 tempdir=elc.$$ 211 local tempdir=elc.$$
182 mkdir ${tempdir} 212 mkdir ${tempdir}
183 cp "$@" ${tempdir} 213 cp "$@" ${tempdir}
184 pushd ${tempdir} 214 pushd ${tempdir}
185 215
186 echo "(add-to-list 'load-path \"../\")" > script 216 echo "(add-to-list 'load-path \"../\")" > script
189 mv *.elc .. 219 mv *.elc ..
190 220
191 popd 221 popd
192 rm -fr ${tempdir} 222 rm -fr ${tempdir}
193 223
194 eend ${ret} "batch-byte-compile failed" 224 eend ${ret} "elisp-comp: batch-byte-compile failed"
195 return ${ret}
196} 225}
197 226
198# @FUNCTION: elisp-emacs-version 227# @FUNCTION: elisp-emacs-version
199# @DESCRIPTION: 228# @DESCRIPTION:
200# Output version of currently active Emacs. 229# Output version of currently active Emacs.
236 ${EMACS} ${EMACSFLAGS} \ 265 ${EMACS} ${EMACSFLAGS} \
237 --eval "(setq make-backup-files nil)" \ 266 --eval "(setq make-backup-files nil)" \
238 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 267 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
239 -f batch-update-autoloads "${@-.}" 268 -f batch-update-autoloads "${@-.}"
240 269
241 eend $? "batch-update-autoloads failed" 270 eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
242} 271}
243 272
244# @FUNCTION: elisp-install 273# @FUNCTION: elisp-install
245# @USAGE: <subdirectory> <list of files> 274# @USAGE: <subdirectory> <list of files>
246# @DESCRIPTION: 275# @DESCRIPTION:
252 ebegin "Installing Elisp files for GNU Emacs support" 281 ebegin "Installing Elisp files for GNU Emacs support"
253 ( # subshell to avoid pollution of calling environment 282 ( # subshell to avoid pollution of calling environment
254 insinto "${SITELISP}/${subdir}" 283 insinto "${SITELISP}/${subdir}"
255 doins "$@" 284 doins "$@"
256 ) 285 )
257 eend $? "doins failed" 286 eend $? "elisp-install: doins failed"
258} 287}
259 288
260# @FUNCTION: elisp-site-file-install 289# @FUNCTION: elisp-site-file-install
261# @USAGE: <site-init file> [subdirectory] 290# @USAGE: <site-init file> [subdirectory]
262# @DESCRIPTION: 291# @DESCRIPTION:
272 insinto "${SITELISP}/site-gentoo.d" 301 insinto "${SITELISP}/site-gentoo.d"
273 doins "${sf}" 302 doins "${sf}"
274 ) 303 )
275 ret=$? 304 ret=$?
276 rm -f "${sf}" 305 rm -f "${sf}"
277 eend ${ret} "doins failed" 306 eend ${ret} "elisp-site-file-install: doins failed"
278} 307}
279 308
280# @FUNCTION: elisp-site-regen 309# @FUNCTION: elisp-site-regen
281# @DESCRIPTION: 310# @DESCRIPTION:
282# Regenerate site-gentoo.el file. The old location for site initialisation 311# Regenerate the site-gentoo.el file, based on packages' site initialisation
283# files of packages was /usr/share/emacs/site-lisp/. In December 2007 this 312# files in the /usr/share/emacs/site-lisp/site-gentoo.d/ directory.
284# has been changed to /usr/share/emacs/site-lisp/site-gentoo.d/. Remerge of 313#
285# packages with Emacs support is enough, the old location is still supported 314# Note: Before December 2007, site initialisation files were installed in
286# when generating the start-up file. 315# /usr/share/emacs/site-lisp/. For backwards compatibility, this location is
316# still supported when generating site-gentoo.el.
287 317
288elisp-site-regen() { 318elisp-site-regen() {
289 local i sf line obsolete 319 local i sf line firstrun obsolete
290 local -a sflist 320 local -a sflist
291 # Work around Paludis borkage: variable T is empty in pkg_postrm 321 # Work around Paludis borkage: variable T is empty in pkg_postrm
292 local tmpdir=${T:-$(mktemp -d)} 322 local tmpdir=${T:-$(mktemp -d)}
293 323
294 if [ ! -d "${ROOT}${SITELISP}" ]; then 324 if [ ! -d "${ROOT}${SITELISP}" ]; then
295 eerror "Directory ${SITELISP} does not exist" 325 eerror "elisp-site-regen: Directory ${SITELISP} does not exist"
296 return 1 326 return 1
297 fi 327 fi
298 328
299 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \ 329 [ -e "${ROOT}${SITELISP}"/site-gentoo.el ] || firstrun=t
330
300 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then 331 if [ "${firstrun}" ] && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
301 einfo "Creating default ${SITELISP}/site-start.el ..." 332 einfo "Creating default ${SITELISP}/site-start.el ..."
302 cat <<-EOF >"${tmpdir}"/site-start.el 333 cat <<-EOF >"${tmpdir}"/site-start.el
303 ;;; site-start.el 334 ;;; site-start.el
304 335
305 ;;; Commentary: 336 ;;; Commentary:
347 ;; Automatically generated by elisp-common.eclass 378 ;; Automatically generated by elisp-common.eclass
348 ;; DO NOT EDIT THIS FILE 379 ;; DO NOT EDIT THIS FILE
349 380
350 ;;; Code: 381 ;;; Code:
351 EOF 382 EOF
383 # Use sed instead of cat here, since files may miss a trailing newline.
352 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el 384 sed '$q' "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
353 cat <<-EOF >>"${tmpdir}"/site-gentoo.el 385 cat <<-EOF >>"${tmpdir}"/site-gentoo.el
354 386
355 (provide 'site-gentoo) 387 (provide 'site-gentoo)
356 388
357 ;; Local Variables: 389 ;; Local Variables:
369 else 401 else
370 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el 402 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
371 [ -f "${tmpdir}"/site-start.el ] \ 403 [ -f "${tmpdir}"/site-start.el ] \
372 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \ 404 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
373 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el 405 && 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 406 echo
407 einfo "... ${#sflist[@]} site initialisation file(s) included."
408 fi
409
410 if [ "${firstrun}" ]; then
411 echo
381 while read line; do einfo "${line}"; done <<EOF 412 while read line; do einfo "${line:- }"; done <<-EOF
382All site initialisation for Gentoo-installed packages is added to 413 All site initialisation for Gentoo-installed packages is added to
383/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer 414 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is not
384managed by Gentoo. You are responsible for all maintenance of 415 managed by Gentoo. You are responsible for all maintenance of
385site-start.el if there is such a file. 416 site-start.el if there is such a file.
386 417
387In order for this site initialisation to be loaded for all users 418 In order for this site initialisation to be loaded for all users
388automatically, you can add a line like this: 419 automatically, you can add a line like this:
389 420
390 (require 'site-gentoo) 421 (require 'site-gentoo)
391 422
392to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 423 to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
393can be added by individual users to their initialisation files, or, 424 can be added by individual users to their initialisation files, or,
394for greater flexibility, users can load individual package-specific 425 for greater flexibility, users can load individual package-specific
395initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/. 426 initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
396EOF 427 EOF
397 echo 428 echo
398 fi 429 fi
399 430
400 if [ "${obsolete}" ]; then 431 if [ "${obsolete}" ]; then
432 echo
401 while read line; do ewarn "${line}"; done <<-EOF 433 while read line; do ewarn "${line}"; done <<-EOF
402 Site-initialisation files of Emacs packages are now installed in 434 Site-initialisation files of Emacs packages are now installed in
403 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend 435 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
404 that you use /usr/sbin/emacs-updater to rebuild the installed 436 that you use app-admin/emacs-updater to rebuild the installed
405 Emacs packages. 437 Emacs packages.
406 EOF 438 EOF
407 echo
408 439
409 # Kludge for backwards compatibility: During pkg_postrm, old versions 440 # Kludge for backwards compatibility: During pkg_postrm, old versions
410 # of this eclass (saved in the VDB) won't find packages' site-init 441 # of this eclass (saved in the VDB) won't find packages' site-init
411 # files in the new location. So we copy them to an auxiliary file 442 # files in the new location. So we copy them to an auxiliary file
412 # that is visible to old eclass versions. 443 # that is visible to old eclass versions.
416 done 447 done
417 fi 448 fi
418 449
419 # cleanup 450 # cleanup
420 rm -f "${tmpdir}"/site-{gentoo,start}.el 451 rm -f "${tmpdir}"/site-{gentoo,start}.el
452
453 return 0
421} 454}

Legend:
Removed from v.1.41  
changed lines
  Added in v.1.50

  ViewVC Help
Powered by ViewVC 1.1.20