/[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.11 Revision 1.43
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.11 2005/07/06 20:20:03 agriffis Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.43 2008/08/27 06:53:41 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
11INHERITED="$INHERITED $ECLASS" 130# @ECLASS-VARIABLE: SITELISP
12 131# @DESCRIPTION:
132# Directory where packages install Emacs Lisp files.
13SITELISP=/usr/share/emacs/site-lisp 133SITELISP=/usr/share/emacs/site-lisp
14 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
15elisp-compile() { 172elisp-compile() {
16 /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"
17} 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 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}
216}
217
218# @FUNCTION: elisp-emacs-version
219# @DESCRIPTION:
220# Output version of currently active Emacs.
221
222elisp-emacs-version() {
223 # The following will work for at least versions 18-23.
224 echo "(princ emacs-version)" >"${T}"/emacs-version.el
225 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
226 rm -f "${T}"/emacs-version.el
227}
228
229# @FUNCTION: elisp-make-autoload-file
230# @USAGE: [output file] [list of directories]
231# @DESCRIPTION:
232# Generate a file with autoload definitions for the lisp functions.
233
234elisp-make-autoload-file() {
235 local f="${1:-${PN}-autoloads.el}"
236 shift
237 ebegin "Generating autoload file for GNU Emacs"
238
239 sed 's/^FF/\f/' >"${f}" <<-EOF
240 ;;; ${f##*/} --- autoloads for ${P}
241
242 ;;; Commentary:
243 ;; Automatically generated by elisp-common.eclass
244 ;; DO NOT EDIT THIS FILE
245
246 ;;; Code:
247 FF
248 ;; Local Variables:
249 ;; version-control: never
250 ;; no-byte-compile: t
251 ;; no-update-autoloads: t
252 ;; End:
253 ;;; ${f##*/} ends here
254 EOF
255
256 ${EMACS} ${EMACSFLAGS} \
257 --eval "(setq make-backup-files nil)" \
258 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
259 -f batch-update-autoloads "${@-.}"
260
261 eend $? "batch-update-autoloads failed"
262}
263
264# @FUNCTION: elisp-install
265# @USAGE: <subdirectory> <list of files>
266# @DESCRIPTION:
267# Install files in SITELISP directory.
18 268
19elisp-install() { 269elisp-install() {
20 local subdir=$1 270 local subdir="$1"
21 dodir ${SITELISP}/${subdir}
22 insinto ${SITELISP}/${subdir}
23 shift 271 shift
272 ebegin "Installing Elisp files for GNU Emacs support"
273 ( # subshell to avoid pollution of calling environment
274 insinto "${SITELISP}/${subdir}"
24 doins $@ 275 doins "$@"
276 )
277 eend $? "doins failed"
25} 278}
279
280# @FUNCTION: elisp-site-file-install
281# @USAGE: <site-init file> [subdirectory]
282# @DESCRIPTION:
283# Install Emacs site-init file in SITELISP directory.
26 284
27elisp-site-file-install() { 285elisp-site-file-install() {
28 local sitefile=$1 my_pn=${2:-${PN}} 286 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
29 pushd ${S} 287 ebegin "Installing site initialisation file for GNU Emacs"
30 cp ${sitefile} ${T} 288 cp "$1" "${sf}"
31 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" ${T}/$(basename ${sitefile}) 289 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
32 insinto ${SITELISP} 290 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}"
33 doins ${T}/$(basename ${sitefile}) || die "failed to install site file" 291 ( # subshell to avoid pollution of calling environment
34 popd 292 insinto "${SITELISP}/site-gentoo.d"
293 doins "${sf}"
294 )
295 ret=$?
296 rm -f "${sf}"
297 eend ${ret} "doins failed"
35} 298}
299
300# @FUNCTION: elisp-site-regen
301# @DESCRIPTION:
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.
36 307
37elisp-site-regen() { 308elisp-site-regen() {
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
318
319 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
320 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
321 einfo "Creating default ${SITELISP}/site-start.el ..."
322 cat <<-EOF >"${tmpdir}"/site-start.el
323 ;;; site-start.el
324
325 ;;; Commentary:
326 ;; This default site startup file is installed by elisp-common.eclass.
327 ;; You may replace this file by your own site initialisation, or even
328 ;; remove it completely; it will not be recreated.
329
330 ;;; Code:
331 ;; Load site initialisation for Gentoo-installed packages.
332 (require 'site-gentoo)
333
334 ;;; site-start.el ends here
335 EOF
336 fi
337
38 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 338 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
39 einfo ""
40 cat <<EOF >${SITELISP}/site-gentoo.el
41;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE
42;;; -----------------------------------------------------------------
43 339
44EOF 340 # remove any auxiliary file (from previous run)
45 ls ${SITELISP}/[0-9][0-9]*-gentoo.el |sort -n | \ 341 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
46 while read sf 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
47 do 349 do
48 einfo " Adding $(basename $sf) ..." 350 [ -r "${sf}" ] || continue
49 # Great for debugging, too noisy and slow for users though 351 # sort files by their basename. straight insertion sort.
50# echo "(message \"Loading $sf ...\")" >>${SITELISP}/site-start.el 352 for ((i=${#sflist[@]}; i>0; i--)); do
51 cat $sf >>${SITELISP}/site-gentoo.el 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
52 done 359 done
53 while read line; do einfo "${line}"; done <<EOF
54 360
55All site initialization for Gentoo-installed packages is now added to 361 eval "${old_shopts}"
56/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
57managed by Gentoo. You are responsible for all maintenance of
58site-start.el if there is such a file.
59 362
60In order for this site initialization to be loaded for all users 363 cat <<-EOF >"${tmpdir}"/site-gentoo.el
61automatically, as was done previously, you can add a line like this: 364 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
62 365
63 (load "/usr/share/emacs/site-lisp/site-gentoo") 366 ;;; Commentary:
367 ;; Automatically generated by elisp-common.eclass
368 ;; DO NOT EDIT THIS FILE
64 369
65to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 370 ;;; Code:
66can be added by individual users to their initialization files, or for
67greater flexibility, users can select which of the package-specific
68initialization files in /usr/share/emacs/site-lisp to load.
69EOF 371 EOF
70 echo 372 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
71} 373 cat <<-EOF >>"${tmpdir}"/site-gentoo.el
72 374
73# The following Emacs Lisp compilation routine is taken from GNU 375 (provide 'site-gentoo)
74# autotools.
75 376
76elisp-comp() { 377 ;; Local Variables:
77# Copyright 1995 Free Software Foundation, Inc. 378 ;; no-byte-compile: t
78# François Pinard <pinard@iro.umontreal.ca>, 1995. 379 ;; End:
79# 380 ;;; site-gentoo.el ends here
80# This program is free software; you can redistribute it and/or modify 381 EOF
81# it under the terms of the GNU General Public License as published by
82# the Free Software Foundation; either version 2, or (at your option)
83# any later version.
84#
85# This program is distributed in the hope that it will be useful,
86# but WITHOUT ANY WARRANTY; without even the implied warranty of
87# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
88# GNU General Public License for more details.
89#
90# You should have received a copy of the GNU General Public License
91# along with this program; if not, write to the Free Software
92# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
93 382
94# As a special exception to the GNU General Public License, if you 383 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el
95# distribute this file as part of a program that contains a 384 then
96# configuration script generated by Autoconf, you may include it under 385 # This prevents outputting unnecessary text when there
97# the same distribution terms that you use for the rest of that program. 386 # was actually no change.
98 387 # A case is a remerge where we have doubled output.
99# This script byte-compiles all `.el' files which are part of its 388 echo " no changes."
100# arguments, using GNU Emacs, and put the resulting `.elc' files into
101# the current directory, so disregarding the original directories used
102# in `.el' arguments.
103#
104# This script manages in such a way that all Emacs LISP files to
105# be compiled are made visible between themselves, in the event
106# they require or load-library one another.
107
108 if test $# = 0; then
109 echo 1>&2 "No files given to $0"
110 exit 1
111 else 389 else
112 if test -z "$EMACS" || test "$EMACS" = "t"; then 390 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
113 # Value of "t" means we are running in a shell under Emacs. 391 [ -f "${tmpdir}"/site-start.el ] \
114 # Just assume Emacs is called "emacs". 392 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
115 EMACS=emacs 393 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
116 fi 394 echo; einfo
395 for sf in "${sflist[@]##*/}"; do
396 einfo " Adding ${sf} ..."
397 done
398 einfo "Regenerated ${SITELISP}/site-gentoo.el."
117 399
118 tempdir=elc.$$ 400 echo
119 mkdir $tempdir 401 while read line; do einfo "${line:- }"; done <<-EOF
120 cp $* $tempdir 402 All site initialisation for Gentoo-installed packages is added to
121 cd $tempdir 403 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is not
404 managed by Gentoo. You are responsible for all maintenance of
405 site-start.el if there is such a file.
122 406
123 echo "(add-to-list 'load-path \"../\")" > script 407 In order for this site initialisation to be loaded for all users
124 $EMACS -batch -q --no-site-file --no-init-file -l script -f batch-byte-compile *.el 408 automatically, you can add a line like this:
125 mv *.elc ..
126 409
127 cd .. 410 (require 'site-gentoo)
128 rm -fr $tempdir 411
412 to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
413 can be added by individual users to their initialisation files, or,
414 for greater flexibility, users can load individual package-specific
415 initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
416 EOF
417 echo
129 fi 418 fi
130}
131 419
132# Local Variables: *** 420 if [ "${obsolete}" ]; then
133# mode: shell-script *** 421 while read line; do ewarn "${line}"; done <<-EOF
134# tab-width: 4 *** 422 Site-initialisation files of Emacs packages are now installed in
135# indent-tabs-mode: t *** 423 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
136# End: *** 424 that you use /usr/sbin/emacs-updater to rebuild the installed
425 Emacs packages.
426 EOF
427 echo
137 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}

Legend:
Removed from v.1.11  
changed lines
  Added in v.1.43

  ViewVC Help
Powered by ViewVC 1.1.20