/[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.10 Revision 1.46
1# Copyright 1999-2004 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.10 2005/05/03 09:20:13 usata Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.46 2008/09/19 08:12:48 ulm Exp $
4# 4#
5# Copyright 2002-2003 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>
8# Copyright 2007-2008 Christian Faulhammer <opfer@gentoo.org>
9# Copyright 2007-2008 Ulrich Müller <ulm@gentoo.org>
7# 10#
8# This is not an eclass, but it does provide emacs-related 11# @ECLASS: elisp-common.eclass
9# installation utilities. 12# @MAINTAINER:
13# Feel free to contact the Emacs team through <emacs@gentoo.org> if you have
14# problems, suggestions or questions.
15# @BLURB: Emacs-related installation utilities
16# @DESCRIPTION:
17#
18# Usually you want to use this eclass for (optional) GNU Emacs support of
19# your package. This is NOT for XEmacs!
20#
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
23# files you gathered from somewhere else.
24#
25# When relying on the emacs USE flag, you need to add
26#
27# emacs? ( virtual/emacs )
28#
29# to your DEPEND/RDEPEND line and use the functions provided here to bring
30# the files to the correct locations.
31#
32# .SS
33# src_compile() usage:
34#
35# An elisp file is compiled by the elisp-compile() function defined here and
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.
39#
40# elisp-compile *.el || die "elisp-compile failed"
41#
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
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
48# directory) as its arguments. Use of this function requires that the elisp
49# source files contain magic ";;;###autoload" comments. See the Emacs Lisp
50# Reference Manual (node "Autoload") for a detailed explanation.
51#
52# .SS
53# src_install() usage:
54#
55# 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
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
59# something else, but remember to tell elisp-site-file-install() (see below)
60# the change, as it defaults to ${PN}.
61#
62# elisp-install ${PN} *.el *.elc || die "elisp-install failed"
63#
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
66# code (have a look in the documentation of your software). Normally this
67# would look like this:
68#
69# ;;; csv-mode site-lisp configuration
70#
71# (add-to-list 'load-path "@SITELISP@")
72# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
73# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
74#
75# If your Emacs support files are installed in a subdirectory of
76# /usr/share/emacs/site-lisp/ (which is recommended), you need to extend
77# Emacs' load-path as shown in the first non-comment.
78# The elisp-site-file-install() function of this eclass will replace
79# "@SITELISP@" by the actual path.
80#
81# The next line tells Emacs to load the mode opening a file ending with
82# ".csv" and load functions depending on the context and needed features.
83# Be careful though. Commands as "load-library" or "require" bloat the
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
86# keybindings as they might interfere with the user's settings. Give a hint
87# in pkg_postinst(), which should be enough.
88#
89# The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the
90# two digits at the beginning define the loading order. So if you depend on
91# another Emacs package, your site file's number must be higher!
92#
93# Best practice is to define a SITEFILE variable in the global scope of your
94# ebuild (right after DEPEND e.g.):
95#
96# SITEFILE=50${PN}-gentoo.el
97#
98# Which is then installed by
99#
100# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
101#
102# in src_install(). If your subdirectory is not named ${PN}, give the
103# differing name as second argument.
104#
105# .SS
106# pkg_postinst() / pkg_postrm() usage:
107#
108# After that you need to recreate the start-up file of Emacs after emerging
109# and unmerging by using
110#
111# pkg_postinst() {
112# elisp-site-regen
113# }
114#
115# pkg_postrm() {
116# elisp-site-regen
117# }
118#
119# When having optional Emacs support, you should prepend "use emacs &&" to
120# above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"!
121# When unmerging the state of the emacs USE flag is taken from the package
122# database and not from the environment, so it is no problem when you unset
123# USE=emacs between merge and unmerge of a package.
124#
125# .SS
126# Miscellaneous functions:
127#
128# elisp-emacs-version() outputs the version of the currently active Emacs.
10 129
11ECLASS=elisp-common 130# @ECLASS-VARIABLE: SITELISP
12INHERITED="$INHERITED $ECLASS" 131# @DESCRIPTION:
13 132# Directory where packages install Emacs Lisp files.
14SITELISP=/usr/share/emacs/site-lisp 133SITELISP=/usr/share/emacs/site-lisp
15 134
135# Directory where packages install miscellaneous (not Lisp) files.
136SITEETC=/usr/share/emacs/etc
137
138# @ECLASS-VARIABLE: SITEFILE
139# @DESCRIPTION:
140# Name of package's site-init file.
141SITEFILE=50${PN}-gentoo.el
142
143# @ECLASS-VARIABLE: EMACS
144# @DESCRIPTION:
145# Path of Emacs executable.
146EMACS=/usr/bin/emacs
147
148# @ECLASS-VARIABLE: EMACSFLAGS
149# @DESCRIPTION:
150# Flags for executing Emacs in batch mode.
151# These work for Emacs versions 18-23, so don't change them.
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 ."
158
159# @FUNCTION: elisp-compile
160# @USAGE: <list of elisp files>
161# @DESCRIPTION:
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.
171
16elisp-compile() { 172elisp-compile() {
17 /usr/bin/emacs --batch -f batch-byte-compile --no-site-file --no-init-file $* 173 ebegin "Compiling GNU Emacs Elisp files"
174 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
175 eend $? "batch-byte-compile failed"
18} 176}
177
178# #FUNCTION: elisp-comp
179# #USAGE: <list of elisp files>
180# #DESCRIPTION:
181# Byte-compile interdependent Emacs Lisp files.
182# THIS FUNCTION IS DEPRECATED.
183#
184# This function byte-compiles all ".el" files which are part of its
185# arguments, using GNU Emacs, and puts the resulting ".elc" files into the
186# current directory, so disregarding the original directories used in ".el"
187# arguments.
188#
189# This function manages in such a way that all Emacs Lisp files to be
190# compiled are made visible between themselves, in the event they require or
191# load one another.
192
193elisp-comp() {
194 # Copyright 1995 Free Software Foundation, Inc.
195 # François Pinard <pinard@iro.umontreal.ca>, 1995.
196 # Originally taken from GNU autotools.
197
198 ewarn "Function elisp-comp is deprecated and may be removed in future."
199 ewarn "Please use function elisp-compile instead, or report a bug about"
200 ewarn "${CATEGORY}/${PF} at <http://bugs.gentoo.org/>."
201 echo
202
203 [ $# -gt 0 ] || return 1
204
205 ebegin "Compiling GNU Emacs Elisp files"
206
207 local tempdir=elc.$$
208 mkdir ${tempdir}
209 cp "$@" ${tempdir}
210 pushd ${tempdir}
211
212 echo "(add-to-list 'load-path \"../\")" > script
213 ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el
214 local ret=$?
215 mv *.elc ..
216
217 popd
218 rm -fr ${tempdir}
219
220 eend ${ret} "batch-byte-compile failed"
221 return ${ret}
222}
223
224# @FUNCTION: elisp-emacs-version
225# @DESCRIPTION:
226# Output version of currently active Emacs.
227
228elisp-emacs-version() {
229 # The following will work for at least versions 18-23.
230 echo "(princ emacs-version)" >"${T}"/emacs-version.el
231 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
232 rm -f "${T}"/emacs-version.el
233}
234
235# @FUNCTION: elisp-make-autoload-file
236# @USAGE: [output file] [list of directories]
237# @DESCRIPTION:
238# Generate a file with autoload definitions for the lisp functions.
239
240elisp-make-autoload-file() {
241 local f="${1:-${PN}-autoloads.el}"
242 shift
243 ebegin "Generating autoload file for GNU Emacs"
244
245 sed 's/^FF/\f/' >"${f}" <<-EOF
246 ;;; ${f##*/} --- autoloads for ${P}
247
248 ;;; Commentary:
249 ;; Automatically generated by elisp-common.eclass
250 ;; DO NOT EDIT THIS FILE
251
252 ;;; Code:
253 FF
254 ;; Local Variables:
255 ;; version-control: never
256 ;; no-byte-compile: t
257 ;; no-update-autoloads: t
258 ;; End:
259 ;;; ${f##*/} ends here
260 EOF
261
262 ${EMACS} ${EMACSFLAGS} \
263 --eval "(setq make-backup-files nil)" \
264 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
265 -f batch-update-autoloads "${@-.}"
266
267 eend $? "batch-update-autoloads failed"
268}
269
270# @FUNCTION: elisp-install
271# @USAGE: <subdirectory> <list of files>
272# @DESCRIPTION:
273# Install files in SITELISP directory.
19 274
20elisp-install() { 275elisp-install() {
21 local subdir=$1 276 local subdir="$1"
22 dodir ${SITELISP}/${subdir}
23 insinto ${SITELISP}/${subdir}
24 shift 277 shift
278 ebegin "Installing Elisp files for GNU Emacs support"
279 ( # subshell to avoid pollution of calling environment
280 insinto "${SITELISP}/${subdir}"
25 doins $@ 281 doins "$@"
282 )
283 eend $? "doins failed"
26} 284}
285
286# @FUNCTION: elisp-site-file-install
287# @USAGE: <site-init file> [subdirectory]
288# @DESCRIPTION:
289# Install Emacs site-init file in SITELISP directory.
27 290
28elisp-site-file-install() { 291elisp-site-file-install() {
29 local sitefile=$1 my_pn=${2:-${PN}} 292 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
30 pushd ${S} 293 ebegin "Installing site initialisation file for GNU Emacs"
31 cp ${sitefile} ${T} 294 cp "$1" "${sf}"
32 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" ${T}/$(basename ${sitefile}) 295 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
33 insinto ${SITELISP} 296 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}"
34 doins ${T}/$(basename ${sitefile}) || die "failed to install site file" 297 ( # subshell to avoid pollution of calling environment
35 popd 298 insinto "${SITELISP}/site-gentoo.d"
299 doins "${sf}"
300 )
301 ret=$?
302 rm -f "${sf}"
303 eend ${ret} "doins failed"
36} 304}
305
306# @FUNCTION: elisp-site-regen
307# @DESCRIPTION:
308# Regenerate site-gentoo.el file. The old location for site initialisation
309# files of packages was /usr/share/emacs/site-lisp/. In December 2007 this
310# has been changed to /usr/share/emacs/site-lisp/site-gentoo.d/. Remerge of
311# packages with Emacs support is enough, the old location is still supported
312# when generating the start-up file.
37 313
38elisp-site-regen() { 314elisp-site-regen() {
315 local i sf line obsolete
316 local -a sflist
317 # Work around Paludis borkage: variable T is empty in pkg_postrm
318 local tmpdir=${T:-$(mktemp -d)}
319
320 if [ ! -d "${ROOT}${SITELISP}" ]; then
321 eerror "Directory ${SITELISP} does not exist"
322 return 1
323 fi
324
325 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
326 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
327 einfo "Creating default ${SITELISP}/site-start.el ..."
328 cat <<-EOF >"${tmpdir}"/site-start.el
329 ;;; site-start.el
330
331 ;;; Commentary:
332 ;; This default site startup file is installed by elisp-common.eclass.
333 ;; You may replace this file by your own site initialisation, or even
334 ;; remove it completely; it will not be recreated.
335
336 ;;; Code:
337 ;; Load site initialisation for Gentoo-installed packages.
338 (require 'site-gentoo)
339
340 ;;; site-start.el ends here
341 EOF
342 fi
343
39 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 344 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
40 einfo ""
41 cat <<EOF >${SITELISP}/site-gentoo.el
42;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE
43;;; -----------------------------------------------------------------
44 345
45EOF 346 # remove any auxiliary file (from previous run)
46 ls ${SITELISP}/[0-9][0-9]*-gentoo.el |sort -n | \ 347 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
47 while read sf 348
349 # set nullglob option, there may be a directory without matching files
350 local old_shopts=$(shopt -p nullglob)
351 shopt -s nullglob
352
353 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
354 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
48 do 355 do
49 einfo " Adding $(basename $sf) ..." 356 [ -r "${sf}" ] || continue
50 # Great for debugging, too noisy and slow for users though 357 # sort files by their basename. straight insertion sort.
51# echo "(message \"Loading $sf ...\")" >>${SITELISP}/site-start.el 358 for ((i=${#sflist[@]}; i>0; i--)); do
52 cat $sf >>${SITELISP}/site-gentoo.el 359 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
360 sflist[i]=${sflist[i-1]}
361 done
362 sflist[i]=${sf}
363 # set a flag if there are obsolete files
364 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
53 done 365 done
54 while read line; do einfo "${line}"; done <<EOF
55 366
56All site initialization for Gentoo-installed packages is now added to 367 eval "${old_shopts}"
57/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
58managed by Gentoo. You are responsible for all maintenance of
59site-start.el if there is such a file.
60 368
61In order for this site initialization to be loaded for all users 369 cat <<-EOF >"${tmpdir}"/site-gentoo.el
62automatically, as was done previously, you can add a line like this: 370 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
63 371
64 (load "/usr/share/emacs/site-lisp/site-gentoo") 372 ;;; Commentary:
373 ;; Automatically generated by elisp-common.eclass
374 ;; DO NOT EDIT THIS FILE
65 375
66to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 376 ;;; Code:
67can be added by individual users to their initialization files, or for
68greater flexibility, users can select which of the package-specific
69initialization files in /usr/share/emacs/site-lisp to load.
70EOF 377 EOF
71 echo 378 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
72} 379 cat <<-EOF >>"${tmpdir}"/site-gentoo.el
73 380
74# The following Emacs Lisp compilation routine is taken from GNU 381 (provide 'site-gentoo)
75# autotools.
76 382
77elisp-comp() { 383 ;; Local Variables:
78# Copyright 1995 Free Software Foundation, Inc. 384 ;; no-byte-compile: t
79# François Pinard <pinard@iro.umontreal.ca>, 1995. 385 ;; End:
80# 386 ;;; site-gentoo.el ends here
81# This program is free software; you can redistribute it and/or modify 387 EOF
82# it under the terms of the GNU General Public License as published by
83# the Free Software Foundation; either version 2, or (at your option)
84# any later version.
85#
86# This program is distributed in the hope that it will be useful,
87# but WITHOUT ANY WARRANTY; without even the implied warranty of
88# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
89# GNU General Public License for more details.
90#
91# You should have received a copy of the GNU General Public License
92# along with this program; if not, write to the Free Software
93# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
94 388
95# As a special exception to the GNU General Public License, if you 389 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el
96# distribute this file as part of a program that contains a 390 then
97# configuration script generated by Autoconf, you may include it under 391 # This prevents outputting unnecessary text when there
98# the same distribution terms that you use for the rest of that program. 392 # was actually no change.
99 393 # A case is a remerge where we have doubled output.
100# This script byte-compiles all `.el' files which are part of its 394 echo " no changes."
101# arguments, using GNU Emacs, and put the resulting `.elc' files into
102# the current directory, so disregarding the original directories used
103# in `.el' arguments.
104#
105# This script manages in such a way that all Emacs LISP files to
106# be compiled are made visible between themselves, in the event
107# they require or load-library one another.
108
109 if test $# = 0; then
110 echo 1>&2 "No files given to $0"
111 exit 1
112 else 395 else
113 if test -z "$EMACS" || test "$EMACS" = "t"; then 396 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
114 # Value of "t" means we are running in a shell under Emacs. 397 [ -f "${tmpdir}"/site-start.el ] \
115 # Just assume Emacs is called "emacs". 398 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
116 EMACS=emacs 399 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
117 fi 400 echo
401 for sf in "${sflist[@]##*/}"; do
402 einfo " Adding ${sf} ..."
403 done
404 einfo "Regenerated ${SITELISP}/site-gentoo.el."
118 405
119 tempdir=elc.$$ 406 echo
120 mkdir $tempdir 407 while read line; do einfo "${line:- }"; done <<-EOF
121 cp $* $tempdir 408 All site initialisation for Gentoo-installed packages is added to
122 cd $tempdir 409 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is not
410 managed by Gentoo. You are responsible for all maintenance of
411 site-start.el if there is such a file.
123 412
124 echo "(add-to-list 'load-path \"../\")" > script 413 In order for this site initialisation to be loaded for all users
125 $EMACS -batch -q --no-site-file --no-init-file -l script -f batch-byte-compile *.el 414 automatically, you can add a line like this:
126 mv *.elc ..
127 415
128 cd .. 416 (require 'site-gentoo)
129 rm -fr $tempdir 417
418 to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
419 can be added by individual users to their initialisation files, or,
420 for greater flexibility, users can load individual package-specific
421 initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
422 EOF
423 echo
130 fi 424 fi
131}
132 425
133# Local Variables: *** 426 if [ "${obsolete}" ]; then
134# mode: shell-script *** 427 echo
135# tab-width: 4 *** 428 while read line; do ewarn "${line}"; done <<-EOF
136# indent-tabs-mode: t *** 429 Site-initialisation files of Emacs packages are now installed in
137# End: *** 430 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
431 that you use app-admin/emacs-updater to rebuild the installed
432 Emacs packages.
433 EOF
138 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
444
445 # cleanup
446 rm -f "${tmpdir}"/site-{gentoo,start}.el
447
448 return 0
449}

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.46

  ViewVC Help
Powered by ViewVC 1.1.20