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

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

  ViewVC Help
Powered by ViewVC 1.1.20