/[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.29 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.29 2007/10/14 22:12:30 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#
127# 127#
128# elisp-emacs-version() outputs the version of the currently active Emacs. 128# elisp-emacs-version() outputs the version of the currently active Emacs.
129 129
130# @ECLASS-VARIABLE: SITELISP 130# @ECLASS-VARIABLE: SITELISP
131# @DESCRIPTION: 131# @DESCRIPTION:
132# Directory where Emacs Lisp files are installed. 132# Directory where packages install Emacs Lisp files.
133SITELISP=/usr/share/emacs/site-lisp 133SITELISP=/usr/share/emacs/site-lisp
134
135# Directory where packages install miscellaneous (not Lisp) files.
136SITEETC=/usr/share/emacs/etc
134 137
135# @ECLASS-VARIABLE: SITEFILE 138# @ECLASS-VARIABLE: SITEFILE
136# @DESCRIPTION: 139# @DESCRIPTION:
137# Name of package's site-init file. 140# Name of package's site-init file.
138SITEFILE=50${PN}-gentoo.el 141SITEFILE=50${PN}-gentoo.el
139 142
143# @ECLASS-VARIABLE: EMACS
144# @DESCRIPTION:
145# Path of Emacs executable.
140EMACS=/usr/bin/emacs 146EMACS=/usr/bin/emacs
147
148# @ECLASS-VARIABLE: EMACSFLAGS
149# @DESCRIPTION:
150# Flags for executing Emacs in batch mode.
141# 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.
142EMACS_BATCH_CLEAN="${EMACS} -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 ."
143 158
144# @FUNCTION: elisp-compile 159# @FUNCTION: elisp-compile
145# @USAGE: <list of elisp files> 160# @USAGE: <list of elisp files>
146# @DESCRIPTION: 161# @DESCRIPTION:
147# 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.
148 171
149elisp-compile() { 172elisp-compile() {
150 einfo "Compiling GNU Emacs Elisp files ..." 173 ebegin "Compiling GNU Emacs Elisp files"
151 ${EMACS_BATCH_CLEAN} -f batch-byte-compile "$@" 174 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
175 eend $? "batch-byte-compile failed"
176}
177
178# #FUNCTION: elisp-comp
179# #USAGE: <list of elisp files>
180# #DESCRIPTION:
181# Byte-compile interdependent Emacs Lisp files.
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() {
193 # Copyright 1995 Free Software Foundation, Inc.
194 # François Pinard <pinard@iro.umontreal.ca>, 1995.
195 # Originally taken from GNU autotools.
196
197 [ $# -gt 0 ] || return 1
198
199 ebegin "Compiling GNU Emacs Elisp files"
200
201 local tempdir=elc.$$
202 mkdir ${tempdir}
203 cp "$@" ${tempdir}
204 pushd ${tempdir}
205
206 echo "(add-to-list 'load-path \"../\")" > script
207 ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el
208 local ret=$?
209 mv *.elc ..
210
211 popd
212 rm -fr ${tempdir}
213
214 eend ${ret} "batch-byte-compile failed"
215 return ${ret}
152} 216}
153 217
154# @FUNCTION: elisp-emacs-version 218# @FUNCTION: elisp-emacs-version
155# @DESCRIPTION: 219# @DESCRIPTION:
156# Output version of currently active Emacs. 220# Output version of currently active Emacs.
157 221
158elisp-emacs-version() { 222elisp-emacs-version() {
159 # The following will work for at least versions 18-23. 223 # The following will work for at least versions 18-23.
160 echo "(princ emacs-version)" >"${T}"/emacs-version.el 224 echo "(princ emacs-version)" >"${T}"/emacs-version.el
161 ${EMACS_BATCH_CLEAN} -l "${T}"/emacs-version.el 225 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
226 rm -f "${T}"/emacs-version.el
162} 227}
163 228
164# @FUNCTION: elisp-make-autoload-file 229# @FUNCTION: elisp-make-autoload-file
165# @USAGE: [output file] [list of directories] 230# @USAGE: [output file] [list of directories]
166# @DESCRIPTION: 231# @DESCRIPTION:
167# Generate a file with autoload definitions for the lisp functions. 232# Generate a file with autoload definitions for the lisp functions.
168 233
169elisp-make-autoload-file() { 234elisp-make-autoload-file() {
170 local f="${1:-${PN}-autoloads.el}" 235 local f="${1:-${PN}-autoloads.el}"
171 shift 236 shift
172 einfo "Generating autoload file for GNU Emacs ..." 237 ebegin "Generating autoload file for GNU Emacs"
173 238
174 sed 's/^FF/\f/' >"${f}" <<-EOF 239 sed 's/^FF/\f/' >"${f}" <<-EOF
175 ;;; ${f##*/} --- autoloads for ${P} 240 ;;; ${f##*/} --- autoloads for ${P}
176 241
177 ;;; Commentary: 242 ;;; Commentary:
186 ;; no-update-autoloads: t 251 ;; no-update-autoloads: t
187 ;; End: 252 ;; End:
188 ;;; ${f##*/} ends here 253 ;;; ${f##*/} ends here
189 EOF 254 EOF
190 255
191 ${EMACS_BATCH_CLEAN} \ 256 ${EMACS} ${EMACSFLAGS} \
192 --eval "(setq make-backup-files nil)" \ 257 --eval "(setq make-backup-files nil)" \
193 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 258 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
194 -f batch-update-autoloads "${@-.}" 259 -f batch-update-autoloads "${@-.}"
260
261 eend $? "batch-update-autoloads failed"
195} 262}
196 263
197# @FUNCTION: elisp-install 264# @FUNCTION: elisp-install
198# @USAGE: <subdirectory> <list of files> 265# @USAGE: <subdirectory> <list of files>
199# @DESCRIPTION: 266# @DESCRIPTION:
200# Install files in SITELISP directory. 267# Install files in SITELISP directory.
201 268
202elisp-install() { 269elisp-install() {
203 local subdir="$1" 270 local subdir="$1"
204 shift 271 shift
205 einfo "Installing Elisp files for GNU Emacs support ..." 272 ebegin "Installing Elisp files for GNU Emacs support"
206 ( # subshell to avoid pollution of calling environment 273 ( # subshell to avoid pollution of calling environment
207 insinto "${SITELISP}/${subdir}" 274 insinto "${SITELISP}/${subdir}"
208 doins "$@" 275 doins "$@"
209 ) 276 )
277 eend $? "doins failed"
210} 278}
211 279
212# @FUNCTION: elisp-site-file-install 280# @FUNCTION: elisp-site-file-install
213# @USAGE: <site-init file> [subdirectory] 281# @USAGE: <site-init file> [subdirectory]
214# @DESCRIPTION: 282# @DESCRIPTION:
215# Install Emacs site-init file in SITELISP directory. 283# Install Emacs site-init file in SITELISP directory.
216 284
217elisp-site-file-install() { 285elisp-site-file-install() {
218 local sf="$1" my_pn="${2:-${PN}}" 286 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
219 einfo "Installing site initialisation file for GNU Emacs ..." 287 ebegin "Installing site initialisation file for GNU Emacs"
220 cp "${sf}" "${T}" 288 cp "$1" "${sf}"
221 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename "${sf}")" 289 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
290 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}"
222 ( # subshell to avoid pollution of calling environment 291 ( # subshell to avoid pollution of calling environment
223 insinto "${SITELISP}" 292 insinto "${SITELISP}/site-gentoo.d"
224 doins "${T}/$(basename "${sf}")" 293 doins "${sf}"
225 ) 294 )
295 ret=$?
296 rm -f "${sf}"
297 eend ${ret} "doins failed"
226} 298}
227 299
228# @FUNCTION: elisp-site-regen 300# @FUNCTION: elisp-site-regen
229# @DESCRIPTION: 301# @DESCRIPTION:
230# 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.
231 307
232elisp-site-regen() { 308elisp-site-regen() {
233 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
234 318
235 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \ 319 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
236 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then 320 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
237 einfo "Creating default ${SITELISP}/site-start.el ..." 321 einfo "Creating default ${SITELISP}/site-start.el ..."
238 cat <<-EOF >"${T}"/site-start.el 322 cat <<-EOF >"${tmpdir}"/site-start.el
239 ;;; site-start.el 323 ;;; site-start.el
240 324
241 ;;; Commentary: 325 ;;; Commentary:
242 ;; This default site startup file is installed by elisp-common.eclass. 326 ;; This default site startup file is installed by elisp-common.eclass.
243 ;; 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
250 ;;; site-start.el ends here 334 ;;; site-start.el ends here
251 EOF 335 EOF
252 fi 336 fi
253 337
254 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
255 cat <<-EOF >"${T}"/site-gentoo.el 363 cat <<-EOF >"${tmpdir}"/site-gentoo.el
256 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages 364 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
257 365
258 ;;; Commentary: 366 ;;; Commentary:
259 ;; Automatically generated by elisp-common.eclass 367 ;; Automatically generated by elisp-common.eclass
260 ;; DO NOT EDIT THIS FILE 368 ;; DO NOT EDIT THIS FILE
261 369
262 ;;; Code: 370 ;;; Code:
263 EOF 371 EOF
264 372 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
265 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
266 do
267 [ -r "${sf}" ] || continue
268 sflist="${sflist} $(basename "${sf}")"
269 cat "${sf}" >>"${T}"/site-gentoo.el
270 done
271
272 cat <<-EOF >>"${T}"/site-gentoo.el 373 cat <<-EOF >>"${tmpdir}"/site-gentoo.el
273 374
274 (provide 'site-gentoo) 375 (provide 'site-gentoo)
275 376
276 ;; Local Variables: 377 ;; Local Variables:
277 ;; no-byte-compile: t 378 ;; no-byte-compile: t
278 ;; End: 379 ;; End:
279 ;;; site-gentoo.el ends here 380 ;;; site-gentoo.el ends here
280 EOF 381 EOF
281 382
282 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
283 # This prevents outputting unnecessary text when there 385 # This prevents outputting unnecessary text when there
284 # was actually no change. 386 # was actually no change.
285 # A case is a remerge where we have doubled output. 387 # A case is a remerge where we have doubled output.
286 echo " no changes." 388 echo " no changes."
287 else 389 else
288 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el 390 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
289 [ -f "${T}"/site-start.el ] \ 391 [ -f "${tmpdir}"/site-start.el ] \
290 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \ 392 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
291 && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el 393 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
292 echo; einfo 394 echo; einfo
293 for sf in ${sflist}; do 395 for sf in "${sflist[@]##*/}"; do
294 einfo " Adding ${sf} ..." 396 einfo " Adding ${sf} ..."
295 done 397 done
398 einfo "Regenerated ${SITELISP}/site-gentoo.el."
399
400 echo
296 while read line; do einfo "${line}"; done <<EOF 401 while read line; do einfo "${line:- }"; done <<-EOF
297
298All site initialisation for Gentoo-installed packages is added to 402 All site initialisation for Gentoo-installed packages is added to
299/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
300managed by Gentoo. You are responsible for all maintenance of 404 managed by Gentoo. You are responsible for all maintenance of
301site-start.el if there is such a file. 405 site-start.el if there is such a file.
302 406
303In order for this site initialisation to be loaded for all users 407 In order for this site initialisation to be loaded for all users
304automatically, you can add a line like this: 408 automatically, you can add a line like this:
305 409
306 (require 'site-gentoo) 410 (require 'site-gentoo)
307 411
308to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 412 to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
309can be added by individual users to their initialisation files, or for 413 can be added by individual users to their initialisation files, or,
310greater flexibility, users can select which of the package-specific 414 for greater flexibility, users can load individual package-specific
311initialisation files in /usr/share/emacs/site-lisp/ to load. 415 initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
312EOF 416 EOF
313 echo 417 echo
314 fi 418 fi
315}
316 419
317# @FUNCTION: elisp-comp 420 if [ "${obsolete}" ]; then
318# @USAGE: <list of elisp files> 421 while read line; do ewarn "${line}"; done <<-EOF
319# @DESCRIPTION: 422 Site-initialisation files of Emacs packages are now installed in
320# Byte-compile interdependent Emacs Lisp files. 423 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
321# 424 that you use /usr/sbin/emacs-updater to rebuild the installed
322# This function byte-compiles all ".el" files which are part of its 425 Emacs packages.
323# arguments, using GNU Emacs, and puts the resulting ".elc" files into the 426 EOF
324# current directory, so disregarding the original directories used in ".el" 427 echo
325# arguments.
326#
327# This function manages in such a way that all Emacs Lisp files to be
328# compiled are made visible between themselves, in the event they require or
329# load one another.
330 428
331elisp-comp() { 429 # Kludge for backwards compatibility: During pkg_postrm, old versions
332 # Copyright 1995 Free Software Foundation, Inc. 430 # of this eclass (saved in the VDB) won't find packages' site-init
333 # François Pinard <pinard@iro.umontreal.ca>, 1995. 431 # files in the new location. So we copy them to an auxiliary file
334 # Originally taken from GNU autotools. 432 # that is visible to old eclass versions.
335 433 for sf in "${sflist[@]}"; do
336 test $# -gt 0 || return 1 434 [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
337 435 && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
338 if test -z "${EMACS}" || test "${EMACS}" = "t"; then 436 done
339 # Value of "t" means we are running in a shell under Emacs.
340 # Just assume Emacs is called "emacs".
341 EMACS=/usr/bin/emacs
342 fi 437 fi
343 einfo "Compiling GNU Emacs Elisp files ..."
344 438
345 tempdir=elc.$$ 439 # cleanup
346 mkdir ${tempdir} 440 rm -f "${tmpdir}"/site-{gentoo,start}.el
347 cp "$@" ${tempdir}
348 pushd ${tempdir}
349 441
350 echo "(add-to-list 'load-path \"../\")" > script 442 return 0
351 ${EMACS_BATCH_CLEAN} -l script -f batch-byte-compile *.el
352 local ret=$?
353 mv *.elc ..
354
355 popd
356 rm -fr ${tempdir}
357 return ${ret}
358} 443}

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

  ViewVC Help
Powered by ViewVC 1.1.20