/[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.38 Revision 1.55
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.38 2008/04/04 18:11:28 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.55 2009/02/13 17:15: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>
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 have
14# problems, suggestions or questions. 14# problems, suggestions or questions.
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: EMACS
139# @DESCRIPTION: 143# @DESCRIPTION:
140# Name of package's site-init file. 144# Path of Emacs executable.
141SITEFILE=50${PN}-gentoo.el
142
143EMACS=/usr/bin/emacs 145EMACS=/usr/bin/emacs
146
147# @ECLASS-VARIABLE: EMACSFLAGS
148# @DESCRIPTION:
149# Flags for executing Emacs in batch mode.
144# The following works for Emacs versions 18-23, don't change it. 150# These work for Emacs versions 18-23, so don't change them.
145EMACSFLAGS="-batch -q --no-site-file" 151EMACSFLAGS="-batch -q --no-site-file"
152
153# @ECLASS-VARIABLE: BYTECOMPFLAGS
154# @DESCRIPTION:
155# Emacs flags used for byte-compilation in elisp-compile().
156BYTECOMPFLAGS="-L ."
146 157
147# @FUNCTION: elisp-compile 158# @FUNCTION: elisp-compile
148# @USAGE: <list of elisp files> 159# @USAGE: <list of elisp files>
149# @DESCRIPTION: 160# @DESCRIPTION:
150# Byte-compile Emacs Lisp files. 161# Byte-compile Emacs Lisp files.
162#
163# This function uses GNU Emacs to byte-compile all ".el" specified by its
164# arguments. The resulting byte-code (".elc") files are placed in the same
165# directory as their corresponding source file.
166#
167# The current directory is added to the load-path. This will ensure that
168# interdependent Emacs Lisp files are visible between themselves, in case
169# they require or load one another.
151 170
152elisp-compile() { 171elisp-compile() {
153 ebegin "Compiling GNU Emacs Elisp files" 172 ebegin "Compiling GNU Emacs Elisp files"
154 ${EMACS} ${EMACSFLAGS} -f batch-byte-compile "$@" 173 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
155 eend $? "batch-byte-compile failed" 174 eend $? "elisp-compile: batch-byte-compile failed"
156} 175}
157 176
158# @FUNCTION: elisp-comp 177# #FUNCTION: elisp-comp
159# @USAGE: <list of elisp files> 178# #USAGE: <list of elisp files>
160# @DESCRIPTION: 179# #DESCRIPTION:
161# Byte-compile interdependent Emacs Lisp files. 180# Byte-compile interdependent Emacs Lisp files.
181# THIS FUNCTION IS DEPRECATED.
162# 182#
163# This function byte-compiles all ".el" files which are part of its 183# 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 184# arguments, using GNU Emacs, and puts the resulting ".elc" files into the
165# current directory, so disregarding the original directories used in ".el" 185# current directory, so disregarding the original directories used in ".el"
166# arguments. 186# arguments.
172elisp-comp() { 192elisp-comp() {
173 # Copyright 1995 Free Software Foundation, Inc. 193 # Copyright 1995 Free Software Foundation, Inc.
174 # François Pinard <pinard@iro.umontreal.ca>, 1995. 194 # François Pinard <pinard@iro.umontreal.ca>, 1995.
175 # Originally taken from GNU autotools. 195 # Originally taken from GNU autotools.
176 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
177 [ $# -gt 0 ] || return 1 202 [ $# -gt 0 ] || return 1
178 203
179 ebegin "Compiling GNU Emacs Elisp files" 204 ebegin "Compiling GNU Emacs Elisp files"
180 205
181 tempdir=elc.$$ 206 local tempdir=elc.$$
182 mkdir ${tempdir} 207 mkdir ${tempdir}
183 cp "$@" ${tempdir} 208 cp "$@" ${tempdir}
184 pushd ${tempdir} 209 pushd ${tempdir}
185 210
186 echo "(add-to-list 'load-path \"../\")" > script 211 echo "(add-to-list 'load-path \"../\")" > script
189 mv *.elc .. 214 mv *.elc ..
190 215
191 popd 216 popd
192 rm -fr ${tempdir} 217 rm -fr ${tempdir}
193 218
194 eend ${ret} "batch-byte-compile failed" 219 eend ${ret} "elisp-comp: batch-byte-compile failed"
195 return ${ret}
196} 220}
197 221
198# @FUNCTION: elisp-emacs-version 222# @FUNCTION: elisp-emacs-version
199# @DESCRIPTION: 223# @DESCRIPTION:
200# Output version of currently active Emacs. 224# Output version of currently active Emacs.
236 ${EMACS} ${EMACSFLAGS} \ 260 ${EMACS} ${EMACSFLAGS} \
237 --eval "(setq make-backup-files nil)" \ 261 --eval "(setq make-backup-files nil)" \
238 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 262 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
239 -f batch-update-autoloads "${@-.}" 263 -f batch-update-autoloads "${@-.}"
240 264
241 eend $? "batch-update-autoloads failed" 265 eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
242} 266}
243 267
244# @FUNCTION: elisp-install 268# @FUNCTION: elisp-install
245# @USAGE: <subdirectory> <list of files> 269# @USAGE: <subdirectory> <list of files>
246# @DESCRIPTION: 270# @DESCRIPTION:
252 ebegin "Installing Elisp files for GNU Emacs support" 276 ebegin "Installing Elisp files for GNU Emacs support"
253 ( # subshell to avoid pollution of calling environment 277 ( # subshell to avoid pollution of calling environment
254 insinto "${SITELISP}/${subdir}" 278 insinto "${SITELISP}/${subdir}"
255 doins "$@" 279 doins "$@"
256 ) 280 )
257 eend $? "doins failed" 281 eend $? "elisp-install: doins failed"
258} 282}
259 283
260# @FUNCTION: elisp-site-file-install 284# @FUNCTION: elisp-site-file-install
261# @USAGE: <site-init file> [subdirectory] 285# @USAGE: <site-init file> [subdirectory]
262# @DESCRIPTION: 286# @DESCRIPTION:
265elisp-site-file-install() { 289elisp-site-file-install() {
266 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret 290 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
267 ebegin "Installing site initialisation file for GNU Emacs" 291 ebegin "Installing site initialisation file for GNU Emacs"
268 cp "$1" "${sf}" 292 cp "$1" "${sf}"
269 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \ 293 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
270 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}" 294 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g;\$q" "${sf}"
271 ( # subshell to avoid pollution of calling environment 295 ( # subshell to avoid pollution of calling environment
272 insinto "${SITELISP}/site-gentoo.d" 296 insinto "${SITELISP}/site-gentoo.d"
273 doins "${sf}" 297 doins "${sf}"
274 ) 298 )
275 ret=$? 299 ret=$?
276 rm -f "${sf}" 300 rm -f "${sf}"
277 eend ${ret} "doins failed" 301 eend ${ret} "elisp-site-file-install: doins failed"
278} 302}
279 303
280# @FUNCTION: elisp-site-regen 304# @FUNCTION: elisp-site-regen
281# @DESCRIPTION: 305# @DESCRIPTION:
282# Regenerate site-gentoo.el file. The old location for site initialisation 306# 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 307# 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 308#
285# packages with Emacs support is enough, the old location is still supported 309# Note: Before December 2007, site initialisation files were installed in
286# when generating the start-up file. 310# /usr/share/emacs/site-lisp/. For backwards compatibility, this location is
311# still supported when generating site-gentoo.el.
287 312
288elisp-site-regen() { 313elisp-site-regen() {
289 local i sf line obsolete 314 local i sf line firstrun obsolete
290 local -a sflist 315 local -a sflist
291 # Work around Paludis borkage: variable T is empty in pkg_postrm
292 local tmpdir=${T:-/tmp}
293 316
294 if [ ! -d "${ROOT}${SITELISP}" ]; then 317 if [ ! -d "${ROOT}${SITELISP}" ]; then
295 eerror "Directory ${SITELISP} does not exist" 318 eerror "elisp-site-regen: Directory ${SITELISP} does not exist"
296 return 1 319 return 1
297 fi 320 fi
298 321
322 if [ ! -d "${T}" ]; then
323 eerror "elisp-site-regen: Temporary directory ${T} does not exist"
324 return 1
325 fi
326
299 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \ 327 [ -e "${ROOT}${SITELISP}"/site-gentoo.el ] || firstrun=t
328
300 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then 329 if [ "${firstrun}" ] && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
301 einfo "Creating default ${SITELISP}/site-start.el ..." 330 einfo "Creating default ${SITELISP}/site-start.el ..."
302 cat <<-EOF >"${tmpdir}"/site-start.el 331 cat <<-EOF >"${T}"/site-start.el
303 ;;; site-start.el 332 ;;; site-start.el
304 333
305 ;;; Commentary: 334 ;;; Commentary:
306 ;; This default site startup file is installed by elisp-common.eclass. 335 ;; This default site startup file is installed by elisp-common.eclass.
307 ;; You may replace this file by your own site initialisation, or even 336 ;; You may replace this file by your own site initialisation, or even
315 EOF 344 EOF
316 fi 345 fi
317 346
318 einfon "Regenerating ${SITELISP}/site-gentoo.el ..." 347 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
319 348
320 # remove auxiliary file 349 # remove any auxiliary file (from previous run)
321 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el 350 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
322 351
323 # set nullglob option, there may be a directory without matching files 352 # set nullglob option, there may be a directory without matching files
324 local old_shopts=$(shopt -p nullglob) 353 local old_shopts=$(shopt -p nullglob)
325 shopt -s nullglob 354 shopt -s nullglob
338 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t 367 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
339 done 368 done
340 369
341 eval "${old_shopts}" 370 eval "${old_shopts}"
342 371
343 cat <<-EOF >"${tmpdir}"/site-gentoo.el 372 cat <<-EOF >"${T}"/site-gentoo.el
344 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages 373 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
345 374
346 ;;; Commentary: 375 ;;; Commentary:
347 ;; Automatically generated by elisp-common.eclass 376 ;; Automatically generated by elisp-common.eclass
348 ;; DO NOT EDIT THIS FILE 377 ;; DO NOT EDIT THIS FILE
349 378
350 ;;; Code: 379 ;;; Code:
351 EOF 380 EOF
381 # Use sed instead of cat here, since files may miss a trailing newline.
352 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el 382 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
353 cat <<-EOF >>"${tmpdir}"/site-gentoo.el 383 cat <<-EOF >>"${T}"/site-gentoo.el
354 384
355 (provide 'site-gentoo) 385 (provide 'site-gentoo)
356 386
357 ;; Local Variables: 387 ;; Local Variables:
358 ;; no-byte-compile: t 388 ;; no-byte-compile: t
359 ;; End: 389 ;; End:
360 ;;; site-gentoo.el ends here 390 ;;; site-gentoo.el ends here
361 EOF 391 EOF
362 392
363 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el 393 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el
364 then 394 then
365 # This prevents outputting unnecessary text when there 395 # This prevents outputting unnecessary text when there
366 # was actually no change. 396 # was actually no change.
367 # A case is a remerge where we have doubled output. 397 # A case is a remerge where we have doubled output.
368 echo " no changes." 398 echo " no changes."
369 else 399 else
370 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el 400 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
371 [ -f "${tmpdir}"/site-start.el ] \ 401 [ -f "${T}"/site-start.el ] \
372 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \ 402 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
373 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el 403 && mv "${T}"/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 404 echo
381 while read line; do einfo "${line}"; done <<EOF 405 einfo "... ${#sflist[@]} site initialisation file(s) included."
382All site initialisation for Gentoo-installed packages is added to 406 fi
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 407
387In order for this site initialisation to be loaded for all users 408 if [ "${firstrun}" ]; then
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/.
396EOF
397 echo 409 echo
410 while read line; do einfo "${line:- }"; done <<-EOF
411 All site initialisation for Gentoo-installed packages is added to
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.
398 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
399 if [ "${obsolete}" ]; then 429 if [ "${obsolete}" ]; then
430 echo
400 while read line; do ewarn "${line}"; done <<-EOF 431 while read line; do ewarn "${line}"; done <<-EOF
401 Site-initialisation files of Emacs packages are now installed in 432 Site-initialisation files of Emacs packages are now installed in
402 /usr/share/emacs/site-lisp/site-gentoo.d/. You may consider using 433 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
403 /usr/sbin/emacs-updater to rebuild the installed Emacs packages. 434 that you use app-admin/emacs-updater to rebuild the installed
404 However, the old location is still supported. 435 Emacs packages.
405 EOF 436 EOF
406 echo
407 fi 437 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" ] \
416 && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
417 done
418 438
419 # cleanup 439 # cleanup
420 rm -f "${tmpdir}"/site-{gentoo,start}.el 440 rm -f "${T}"/site-{gentoo,start}.el
441
442 return 0
421} 443}

Legend:
Removed from v.1.38  
changed lines
  Added in v.1.55

  ViewVC Help
Powered by ViewVC 1.1.20