/[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.31 Revision 1.45
1# Copyright 1999-2007 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.31 2007/12/01 15:35:02 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.45 2008/09/01 10:45:26 ulm Exp $
4# 4#
5# Copyright 2007 Christian Faulhammer <opfer@gentoo.org>
6# 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>
7# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org> 7# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
8# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com> 8# Copyright 2007-2008 Christian Faulhammer <opfer@gentoo.org>
9# Copyright 2007 Ulrich Mueller <ulm@gentoo.org> 9# Copyright 2007-2008 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# elisp files is also supported, since the current directory is added to the
38# load-path which makes sure that all files are loadable.
37# 39#
38# elisp-compile *.el || die "elisp-compile failed" 40# elisp-compile *.el || die "elisp-compile failed"
39# 41#
40# In the case of interdependent elisp files, you can use the elisp-comp() 42# Formerly, function elisp-comp() was used for compilation of interdependent
41# function which makes sure all files are loadable. 43# elisp files. This usage is considered as obsolete.
42#
43# elisp-comp *.el || die "elisp-comp failed"
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#
138# @ECLASS-VARIABLE: SITEFILE 138# @ECLASS-VARIABLE: SITEFILE
139# @DESCRIPTION: 139# @DESCRIPTION:
140# Name of package's site-init file. 140# Name of package's site-init file.
141SITEFILE=50${PN}-gentoo.el 141SITEFILE=50${PN}-gentoo.el
142 142
143# @ECLASS-VARIABLE: EMACS
144# @DESCRIPTION:
145# Path of Emacs executable.
143EMACS=/usr/bin/emacs 146EMACS=/usr/bin/emacs
147
148# @ECLASS-VARIABLE: EMACSFLAGS
149# @DESCRIPTION:
150# Flags for executing Emacs in batch mode.
144# The following works for Emacs versions 18--23, don't change it. 151# These work for Emacs versions 18-23, so don't change them.
145EMACSFLAGS="-batch -q --no-site-file" 152EMACSFLAGS="-batch -q --no-site-file"
153
154# @ECLASS-VARIABLE: BYTECOMPFLAGS
155# @DESCRIPTION:
156# Emacs flags used for byte-compilation in elisp-compile().
157BYTECOMPFLAGS="-L ."
146 158
147# @FUNCTION: elisp-compile 159# @FUNCTION: elisp-compile
148# @USAGE: <list of elisp files> 160# @USAGE: <list of elisp files>
149# @DESCRIPTION: 161# @DESCRIPTION:
150# Byte-compile Emacs Lisp files. 162# Byte-compile Emacs Lisp files.
163#
164# This function uses GNU Emacs to byte-compile all ".el" specified by its
165# arguments. The resulting byte-code (".elc") files are placed in the same
166# directory as their corresponding source file.
167#
168# The current directory is added to the load-path. This will ensure that
169# interdependent Emacs Lisp files are visible between themselves, in case
170# they require or load one another.
151 171
152elisp-compile() { 172elisp-compile() {
153 einfo "Compiling GNU Emacs Elisp files ..." 173 ebegin "Compiling GNU Emacs Elisp files"
154 ${EMACS} ${EMACSFLAGS} -f batch-byte-compile "$@" 174 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
175 eend $? "batch-byte-compile failed"
155} 176}
156 177
157# @FUNCTION: elisp-comp 178# #FUNCTION: elisp-comp
158# @USAGE: <list of elisp files> 179# #USAGE: <list of elisp files>
159# @DESCRIPTION: 180# #DESCRIPTION:
160# Byte-compile interdependent Emacs Lisp files. 181# Byte-compile interdependent Emacs Lisp files.
161# 182#
162# 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
163# 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
164# current directory, so disregarding the original directories used in ".el" 185# current directory, so disregarding the original directories used in ".el"
173 # François Pinard <pinard@iro.umontreal.ca>, 1995. 194 # François Pinard <pinard@iro.umontreal.ca>, 1995.
174 # Originally taken from GNU autotools. 195 # Originally taken from GNU autotools.
175 196
176 [ $# -gt 0 ] || return 1 197 [ $# -gt 0 ] || return 1
177 198
178 einfo "Compiling GNU Emacs Elisp files ..." 199 ebegin "Compiling GNU Emacs Elisp files"
179 200
180 tempdir=elc.$$ 201 local tempdir=elc.$$
181 mkdir ${tempdir} 202 mkdir ${tempdir}
182 cp "$@" ${tempdir} 203 cp "$@" ${tempdir}
183 pushd ${tempdir} 204 pushd ${tempdir}
184 205
185 echo "(add-to-list 'load-path \"../\")" > script 206 echo "(add-to-list 'load-path \"../\")" > script
187 local ret=$? 208 local ret=$?
188 mv *.elc .. 209 mv *.elc ..
189 210
190 popd 211 popd
191 rm -fr ${tempdir} 212 rm -fr ${tempdir}
213
214 eend ${ret} "batch-byte-compile failed"
192 return ${ret} 215 return ${ret}
193} 216}
194 217
195# @FUNCTION: elisp-emacs-version 218# @FUNCTION: elisp-emacs-version
196# @DESCRIPTION: 219# @DESCRIPTION:
198 221
199elisp-emacs-version() { 222elisp-emacs-version() {
200 # The following will work for at least versions 18-23. 223 # The following will work for at least versions 18-23.
201 echo "(princ emacs-version)" >"${T}"/emacs-version.el 224 echo "(princ emacs-version)" >"${T}"/emacs-version.el
202 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el 225 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
226 rm -f "${T}"/emacs-version.el
203} 227}
204 228
205# @FUNCTION: elisp-make-autoload-file 229# @FUNCTION: elisp-make-autoload-file
206# @USAGE: [output file] [list of directories] 230# @USAGE: [output file] [list of directories]
207# @DESCRIPTION: 231# @DESCRIPTION:
208# Generate a file with autoload definitions for the lisp functions. 232# Generate a file with autoload definitions for the lisp functions.
209 233
210elisp-make-autoload-file() { 234elisp-make-autoload-file() {
211 local f="${1:-${PN}-autoloads.el}" 235 local f="${1:-${PN}-autoloads.el}"
212 shift 236 shift
213 einfo "Generating autoload file for GNU Emacs ..." 237 ebegin "Generating autoload file for GNU Emacs"
214 238
215 sed 's/^FF/\f/' >"${f}" <<-EOF 239 sed 's/^FF/\f/' >"${f}" <<-EOF
216 ;;; ${f##*/} --- autoloads for ${P} 240 ;;; ${f##*/} --- autoloads for ${P}
217 241
218 ;;; Commentary: 242 ;;; Commentary:
231 255
232 ${EMACS} ${EMACSFLAGS} \ 256 ${EMACS} ${EMACSFLAGS} \
233 --eval "(setq make-backup-files nil)" \ 257 --eval "(setq make-backup-files nil)" \
234 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 258 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
235 -f batch-update-autoloads "${@-.}" 259 -f batch-update-autoloads "${@-.}"
260
261 eend $? "batch-update-autoloads failed"
236} 262}
237 263
238# @FUNCTION: elisp-install 264# @FUNCTION: elisp-install
239# @USAGE: <subdirectory> <list of files> 265# @USAGE: <subdirectory> <list of files>
240# @DESCRIPTION: 266# @DESCRIPTION:
241# Install files in SITELISP directory. 267# Install files in SITELISP directory.
242 268
243elisp-install() { 269elisp-install() {
244 local subdir="$1" 270 local subdir="$1"
245 shift 271 shift
246 einfo "Installing Elisp files for GNU Emacs support ..." 272 ebegin "Installing Elisp files for GNU Emacs support"
247 ( # subshell to avoid pollution of calling environment 273 ( # subshell to avoid pollution of calling environment
248 insinto "${SITELISP}/${subdir}" 274 insinto "${SITELISP}/${subdir}"
249 doins "$@" 275 doins "$@"
250 ) 276 )
277 eend $? "doins failed"
251} 278}
252 279
253# @FUNCTION: elisp-site-file-install 280# @FUNCTION: elisp-site-file-install
254# @USAGE: <site-init file> [subdirectory] 281# @USAGE: <site-init file> [subdirectory]
255# @DESCRIPTION: 282# @DESCRIPTION:
256# Install Emacs site-init file in SITELISP directory. 283# Install Emacs site-init file in SITELISP directory.
257 284
258elisp-site-file-install() { 285elisp-site-file-install() {
259 local sf="$1" my_pn="${2:-${PN}}" 286 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
260 einfo "Installing site initialisation file for GNU Emacs ..." 287 ebegin "Installing site initialisation file for GNU Emacs"
261 cp "${sf}" "${T}" 288 cp "$1" "${sf}"
262 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \ 289 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
263 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${T}/${sf##*/}" 290 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}"
264 ( # subshell to avoid pollution of calling environment 291 ( # subshell to avoid pollution of calling environment
265 insinto "${SITELISP}" 292 insinto "${SITELISP}/site-gentoo.d"
266 doins "${T}/${sf##*/}" 293 doins "${sf}"
267 ) 294 )
295 ret=$?
296 rm -f "${sf}"
297 eend ${ret} "doins failed"
268} 298}
269 299
270# @FUNCTION: elisp-site-regen 300# @FUNCTION: elisp-site-regen
271# @DESCRIPTION: 301# @DESCRIPTION:
272# Regenerate site-gentoo.el file. 302# Regenerate site-gentoo.el file. The old location for site initialisation
303# files of packages was /usr/share/emacs/site-lisp/. In December 2007 this
304# has been changed to /usr/share/emacs/site-lisp/site-gentoo.d/. Remerge of
305# packages with Emacs support is enough, the old location is still supported
306# when generating the start-up file.
273 307
274elisp-site-regen() { 308elisp-site-regen() {
275 local sflist sf line 309 local i sf line obsolete
310 local -a sflist
311 # Work around Paludis borkage: variable T is empty in pkg_postrm
312 local tmpdir=${T:-$(mktemp -d)}
313
314 if [ ! -d "${ROOT}${SITELISP}" ]; then
315 eerror "Directory ${SITELISP} does not exist"
316 return 1
317 fi
276 318
277 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \ 319 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
278 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then 320 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
279 einfo "Creating default ${SITELISP}/site-start.el ..." 321 einfo "Creating default ${SITELISP}/site-start.el ..."
280 cat <<-EOF >"${T}"/site-start.el 322 cat <<-EOF >"${tmpdir}"/site-start.el
281 ;;; site-start.el 323 ;;; site-start.el
282 324
283 ;;; Commentary: 325 ;;; Commentary:
284 ;; This default site startup file is installed by elisp-common.eclass. 326 ;; This default site startup file is installed by elisp-common.eclass.
285 ;; You may replace this file by your own site initialisation, or even 327 ;; You may replace this file by your own site initialisation, or even
292 ;;; site-start.el ends here 334 ;;; site-start.el ends here
293 EOF 335 EOF
294 fi 336 fi
295 337
296 einfon "Regenerating ${SITELISP}/site-gentoo.el ..." 338 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
339
340 # remove any auxiliary file (from previous run)
341 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
342
343 # set nullglob option, there may be a directory without matching files
344 local old_shopts=$(shopt -p nullglob)
345 shopt -s nullglob
346
347 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
348 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
349 do
350 [ -r "${sf}" ] || continue
351 # sort files by their basename. straight insertion sort.
352 for ((i=${#sflist[@]}; i>0; i--)); do
353 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
354 sflist[i]=${sflist[i-1]}
355 done
356 sflist[i]=${sf}
357 # set a flag if there are obsolete files
358 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
359 done
360
361 eval "${old_shopts}"
362
297 cat <<-EOF >"${T}"/site-gentoo.el 363 cat <<-EOF >"${tmpdir}"/site-gentoo.el
298 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages 364 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
299 365
300 ;;; Commentary: 366 ;;; Commentary:
301 ;; Automatically generated by elisp-common.eclass 367 ;; Automatically generated by elisp-common.eclass
302 ;; DO NOT EDIT THIS FILE 368 ;; DO NOT EDIT THIS FILE
303 369
304 ;;; Code: 370 ;;; Code:
305 EOF 371 EOF
306 372 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
307 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
308 do
309 [ -r "${sf}" ] || continue
310 sflist="${sflist} ${sf##*/}"
311 cat "${sf}" >>"${T}"/site-gentoo.el
312 done
313
314 cat <<-EOF >>"${T}"/site-gentoo.el 373 cat <<-EOF >>"${tmpdir}"/site-gentoo.el
315 374
316 (provide 'site-gentoo) 375 (provide 'site-gentoo)
317 376
318 ;; Local Variables: 377 ;; Local Variables:
319 ;; no-byte-compile: t 378 ;; no-byte-compile: t
320 ;; End: 379 ;; End:
321 ;;; site-gentoo.el ends here 380 ;;; site-gentoo.el ends here
322 EOF 381 EOF
323 382
324 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then 383 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el
384 then
325 # This prevents outputting unnecessary text when there 385 # This prevents outputting unnecessary text when there
326 # was actually no change. 386 # was actually no change.
327 # A case is a remerge where we have doubled output. 387 # A case is a remerge where we have doubled output.
328 echo " no changes." 388 echo " no changes."
329 else 389 else
330 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el 390 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
331 [ -f "${T}"/site-start.el ] \ 391 [ -f "${tmpdir}"/site-start.el ] \
332 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \ 392 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
333 && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el 393 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
334 echo; einfo 394 echo; einfo
335 for sf in ${sflist}; do 395 for sf in "${sflist[@]##*/}"; do
336 einfo " Adding ${sf} ..." 396 einfo " Adding ${sf} ..."
337 done 397 done
398 einfo "Regenerated ${SITELISP}/site-gentoo.el."
399
400 echo
338 while read line; do einfo "${line}"; done <<EOF 401 while read line; do einfo "${line:- }"; done <<-EOF
339
340All site initialisation for Gentoo-installed packages is added to 402 All site initialisation for Gentoo-installed packages is added to
341/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer 403 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is not
342managed by Gentoo. You are responsible for all maintenance of 404 managed by Gentoo. You are responsible for all maintenance of
343site-start.el if there is such a file. 405 site-start.el if there is such a file.
344 406
345In order for this site initialisation to be loaded for all users 407 In order for this site initialisation to be loaded for all users
346automatically, you can add a line like this: 408 automatically, you can add a line like this:
347 409
348 (require 'site-gentoo) 410 (require 'site-gentoo)
349 411
350to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 412 to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
351can be added by individual users to their initialisation files, or, 413 can be added by individual users to their initialisation files, or,
352for greater flexibility, users can load individual package-specific 414 for greater flexibility, users can load individual package-specific
353initialisation files from /usr/share/emacs/site-lisp/. 415 initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
354EOF 416 EOF
355 echo 417 echo
356 fi 418 fi
419
420 if [ "${obsolete}" ]; then
421 while read line; do ewarn "${line}"; done <<-EOF
422 Site-initialisation files of Emacs packages are now installed in
423 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
424 that you use /usr/sbin/emacs-updater to rebuild the installed
425 Emacs packages.
426 EOF
427 echo
428
429 # Kludge for backwards compatibility: During pkg_postrm, old versions
430 # of this eclass (saved in the VDB) won't find packages' site-init
431 # files in the new location. So we copy them to an auxiliary file
432 # that is visible to old eclass versions.
433 for sf in "${sflist[@]}"; do
434 [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
435 && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
436 done
437 fi
438
439 # cleanup
440 rm -f "${tmpdir}"/site-{gentoo,start}.el
441
442 return 0
357} 443}

Legend:
Removed from v.1.31  
changed lines
  Added in v.1.45

  ViewVC Help
Powered by ViewVC 1.1.20