/[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.52 Revision 1.75
1# Copyright 1999-2008 Gentoo Foundation 1# Copyright 1999-2011 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.52 2008/11/24 14:21:04 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.75 2011/08/30 20:10:13 ulm Exp $
4#
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>
8# Copyright 2007-2008 Christian Faulhammer <opfer@gentoo.org>
9# Copyright 2007-2008 Ulrich Müller <ulm@gentoo.org>
10# 4#
11# @ECLASS: elisp-common.eclass 5# @ECLASS: elisp-common.eclass
12# @MAINTAINER: 6# @MAINTAINER:
13# Feel free to contact the Emacs team through <emacs@gentoo.org> if you have 7# Gentoo Emacs team <emacs@gentoo.org>
14# problems, suggestions or questions. 8# @AUTHOR:
9# Matthew Kennedy <mkennedy@gentoo.org>
10# Jeremy Maitin-Shepard <jbms@attbi.com>
11# Mamoru Komachi <usata@gentoo.org>
12# Christian Faulhammer <fauli@gentoo.org>
13# Ulrich Müller <ulm@gentoo.org>
15# @BLURB: Emacs-related installation utilities 14# @BLURB: Emacs-related installation utilities
16# @DESCRIPTION: 15# @DESCRIPTION:
17# 16#
18# Usually you want to use this eclass for (optional) GNU Emacs support of 17# Usually you want to use this eclass for (optional) GNU Emacs support
19# your package. This is NOT for XEmacs! 18# of your package. This is NOT for XEmacs!
20# 19#
21# Many of the steps here are sometimes done by the build system of your 20# 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 21# package (especially compilation), so this is mainly for standalone
23# files you gathered from somewhere else. 22# elisp files you gathered from somewhere else.
24# 23#
25# When relying on the emacs USE flag, you need to add 24# When relying on the emacs USE flag, you need to add
26# 25#
27# emacs? ( virtual/emacs ) 26# emacs? ( virtual/emacs )
28# 27#
29# to your DEPEND/RDEPEND line and use the functions provided here to bring 28# to your DEPEND/RDEPEND line and use the functions provided here to
30# the files to the correct locations. 29# bring the files to the correct locations.
30#
31# If your package requires a minimum Emacs version, e.g. Emacs 23, then
32# the dependency should be on >=virtual/emacs-23 instead. Because the
33# user can select the Emacs executable with eselect, you should also
34# make sure that the active Emacs version is sufficient. This can be
35# tested with function elisp-need-emacs(), which would typically be
36# called from pkg_setup(), as in the following example:
37#
38# elisp-need-emacs 23 || die "Emacs version too low"
39#
40# Please note that such tests should be limited to packages that are
41# known to fail with lower Emacs versions; the standard case is to
42# depend on virtual/emacs without version.
31# 43#
32# .SS 44# .SS
33# src_compile() usage: 45# src_compile() usage:
34# 46#
35# An elisp file is compiled by the elisp-compile() function defined here and 47# An elisp file is compiled by the elisp-compile() function defined
36# simply takes the source files as arguments. The case of interdependent 48# here and simply takes the source files as arguments. The case of
37# elisp files is also supported, since the current directory is added to the 49# interdependent elisp files is also supported, since the current
38# load-path which makes sure that all files are loadable. 50# directory is added to the load-path which makes sure that all files
51# are loadable.
39# 52#
40# elisp-compile *.el || die 53# elisp-compile *.el || die
41# 54#
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 55# Function elisp-make-autoload-file() can be used to generate a file
46# autoload definitions for the lisp functions. It takes the output file name 56# with autoload definitions for the lisp functions. It takes the output
47# (default: "${PN}-autoloads.el") and a list of directories (default: working 57# file name (default: "${PN}-autoloads.el") and a list of directories
48# directory) as its arguments. Use of this function requires that the elisp 58# (default: working directory) as its arguments. Use of this function
49# source files contain magic ";;;###autoload" comments. See the Emacs Lisp 59# requires that the elisp source files contain magic ";;;###autoload"
50# Reference Manual (node "Autoload") for a detailed explanation. 60# comments. See the Emacs Lisp Reference Manual (node "Autoload") for
61# a detailed explanation.
51# 62#
52# .SS 63# .SS
53# src_install() usage: 64# src_install() usage:
54# 65#
55# The resulting compiled files (.elc) should be put in a subdirectory of 66# 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 67# /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 68# of elisp-install(). The following parameters are the files to be put
58# that directory. Usually the subdirectory should be ${PN}, you can choose 69# in that directory. Usually the subdirectory should be ${PN}, you can
59# something else, but remember to tell elisp-site-file-install() (see below) 70# choose something else, but remember to tell elisp-site-file-install()
60# the change, as it defaults to ${PN}. 71# (see below) the change, as it defaults to ${PN}.
61# 72#
62# elisp-install ${PN} *.el *.elc || die 73# elisp-install ${PN} *.el *.elc || die
63# 74#
64# To let the Emacs support be activated by Emacs on startup, you need 75# 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 76# to provide a site file (shipped in ${FILESDIR}) which contains the
66# code (have a look in the documentation of your software). Normally this 77# startup code (have a look in the documentation of your software).
67# would look like this: 78# Normally this would look like this:
68#
69# ;;; csv-mode site-lisp configuration
70# 79#
71# (add-to-list 'load-path "@SITELISP@") 80# (add-to-list 'load-path "@SITELISP@")
72# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) 81# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
73# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t) 82# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
74# 83#
75# If your Emacs support files are installed in a subdirectory of 84# If your Emacs support files are installed in a subdirectory of
76# /usr/share/emacs/site-lisp/ (which is recommended), you need to extend 85# /usr/share/emacs/site-lisp/ (which is strongly recommended), you need
77# Emacs' load-path as shown in the first non-comment. 86# to extend Emacs' load-path as shown in the first non-comment line.
78# The elisp-site-file-install() function of this eclass will replace 87# The elisp-site-file-install() function of this eclass will replace
79# "@SITELISP@" by the actual path. 88# "@SITELISP@" and "@SITEETC@" by the actual paths.
80# 89#
81# The next line tells Emacs to load the mode opening a file ending with 90# The next line tells Emacs to load the mode opening a file ending
82# ".csv" and load functions depending on the context and needed features. 91# with ".csv" and load functions depending on the context and needed
83# Be careful though. Commands as "load-library" or "require" bloat the 92# features. Be careful though. Commands as "load-library" or "require"
84# editor as they are loaded on every startup. When having a lot of Emacs 93# bloat the editor as they are loaded on every startup. When having
85# support files, users may be annoyed by the start-up time. Also avoid 94# many Emacs support files, users may be annoyed by the start-up time.
86# keybindings as they might interfere with the user's settings. Give a hint 95# Also avoid keybindings as they might interfere with the user's
87# in pkg_postinst(), which should be enough. 96# settings. Give a hint in pkg_postinst(), which should be enough.
88# 97#
89# The naming scheme for this site-init file matches the shell pattern 98# The naming scheme for this site-init file matches the shell pattern
90# "[1-8][0-9]*-gentoo.el", where the two digits at the beginning define the 99# "[1-8][0-9]*-gentoo*.el", where the two digits at the beginning define
91# loading order (numbers below 10 or above 89 are reserved for internal use). 100# the loading order (numbers below 10 or above 89 are reserved for
92# So if you depend on another Emacs package, your site file's number must be 101# internal use). So if your initialisation depends on another Emacs
93# higher! 102# package, your site file's number must be higher! If there are no such
103# interdependencies then the number should be 50. Otherwise, numbers
104# divisible by 10 are preferred.
94# 105#
95# Best practice is to define a SITEFILE variable in the global scope of your 106# Best practice is to define a SITEFILE variable in the global scope of
96# ebuild (e.g., right after DEPEND): 107# your ebuild (e.g., right after S or RDEPEND):
97# 108#
98# SITEFILE=50${PN}-gentoo.el 109# SITEFILE="50${PN}-gentoo.el"
99# 110#
100# Which is then installed by 111# Which is then installed by
101# 112#
102# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die 113# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
103# 114#
115# in src_install(). Any characters after the "-gentoo" part and before
116# the extension will be stripped from the destination file's name.
117# For example, a file "50${PN}-gentoo-${PV}.el" will be installed as
104# in src_install(). If your subdirectory is not named ${PN}, give the 118# "50${PN}-gentoo.el". If your subdirectory is not named ${PN}, give
105# differing name as second argument. 119# the differing name as second argument.
106# 120#
107# .SS 121# .SS
108# pkg_postinst() / pkg_postrm() usage: 122# pkg_postinst() / pkg_postrm() usage:
109# 123#
110# After that you need to recreate the start-up file of Emacs after emerging 124# After that you need to recreate the start-up file of Emacs after
111# and unmerging by using 125# emerging and unmerging by using
112# 126#
113# pkg_postinst() { 127# pkg_postinst() {
114# elisp-site-regen 128# elisp-site-regen
115# } 129# }
116# 130#
117# pkg_postrm() { 131# pkg_postrm() {
118# elisp-site-regen 132# elisp-site-regen
119# } 133# }
120# 134#
121# When having optional Emacs support, you should prepend "use emacs &&" to 135# When having optional Emacs support, you should prepend "use emacs &&"
122# above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"! 136# to above calls of elisp-site-regen().
123# When unmerging the state of the emacs USE flag is taken from the package 137# Don't use "has_version virtual/emacs"! When unmerging the state of
124# database and not from the environment, so it is no problem when you unset 138# the emacs USE flag is taken from the package database and not from the
139# environment, so it is no problem when you unset USE=emacs between
125# USE=emacs between merge and unmerge of a package. 140# merge and unmerge of a package.
126#
127# .SS
128# Miscellaneous functions:
129#
130# elisp-emacs-version() outputs the version of the currently active Emacs.
131 141
132# @ECLASS-VARIABLE: SITELISP 142# @ECLASS-VARIABLE: SITELISP
133# @DESCRIPTION: 143# @DESCRIPTION:
134# Directory where packages install Emacs Lisp files. 144# Directory where packages install Emacs Lisp files.
135SITELISP=/usr/share/emacs/site-lisp 145SITELISP=/usr/share/emacs/site-lisp
… …
140SITEETC=/usr/share/emacs/etc 150SITEETC=/usr/share/emacs/etc
141 151
142# @ECLASS-VARIABLE: EMACS 152# @ECLASS-VARIABLE: EMACS
143# @DESCRIPTION: 153# @DESCRIPTION:
144# Path of Emacs executable. 154# Path of Emacs executable.
145EMACS=/usr/bin/emacs 155EMACS=${EPREFIX}/usr/bin/emacs
146 156
147# @ECLASS-VARIABLE: EMACSFLAGS 157# @ECLASS-VARIABLE: EMACSFLAGS
148# @DESCRIPTION: 158# @DESCRIPTION:
149# Flags for executing Emacs in batch mode. 159# Flags for executing Emacs in batch mode.
150# These work for Emacs versions 18-23, so don't change them. 160# These work for Emacs versions 18-23, so don't change them.
… …
153# @ECLASS-VARIABLE: BYTECOMPFLAGS 163# @ECLASS-VARIABLE: BYTECOMPFLAGS
154# @DESCRIPTION: 164# @DESCRIPTION:
155# Emacs flags used for byte-compilation in elisp-compile(). 165# Emacs flags used for byte-compilation in elisp-compile().
156BYTECOMPFLAGS="-L ." 166BYTECOMPFLAGS="-L ."
157 167
168# @FUNCTION: elisp-emacs-version
169# @DESCRIPTION:
170# Output version of currently active Emacs.
171
172elisp-emacs-version() {
173 local ret
174 # The following will work for at least versions 18-23.
175 echo "(princ emacs-version)" >"${T}"/emacs-version.el
176 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
177 ret=$?
178 rm -f "${T}"/emacs-version.el
179 if [[ ${ret} -ne 0 ]]; then
180 eerror "elisp-emacs-version: Failed to run ${EMACS}"
181 fi
182 return ${ret}
183}
184
185# @FUNCTION: elisp-need-emacs
186# @USAGE: <version>
187# @RETURN: 0 if true, 1 otherwise
188# @DESCRIPTION:
189# Test if the eselected Emacs version is at least the major version
190# specified as argument.
191
192elisp-need-emacs() {
193 local need_emacs=$1 have_emacs
194 have_emacs=$(elisp-emacs-version) || return
195 einfo "Emacs version: ${have_emacs}"
196 if ! [[ ${have_emacs%%.*} -ge ${need_emacs%%.*} ]]; then
197 eerror "This package needs at least Emacs ${need_emacs%%.*}."
198 eerror "Use \"eselect emacs\" to select the active version."
199 return 1
200 fi
201 return 0
202}
203
158# @FUNCTION: elisp-compile 204# @FUNCTION: elisp-compile
159# @USAGE: <list of elisp files> 205# @USAGE: <list of elisp files>
160# @DESCRIPTION: 206# @DESCRIPTION:
161# Byte-compile Emacs Lisp files. 207# Byte-compile Emacs Lisp files.
162# 208#
163# This function uses GNU Emacs to byte-compile all ".el" specified by its 209# This function uses GNU Emacs to byte-compile all ".el" specified by
164# arguments. The resulting byte-code (".elc") files are placed in the same 210# its arguments. The resulting byte-code (".elc") files are placed in
165# directory as their corresponding source file. 211# the same directory as their corresponding source file.
166# 212#
167# The current directory is added to the load-path. This will ensure that 213# The current directory is added to the load-path. This will ensure
168# interdependent Emacs Lisp files are visible between themselves, in case 214# that interdependent Emacs Lisp files are visible between themselves,
169# they require or load one another. 215# in case they require or load one another.
170 216
171elisp-compile() { 217elisp-compile() {
172 ebegin "Compiling GNU Emacs Elisp files" 218 ebegin "Compiling GNU Emacs Elisp files"
173 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@" 219 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
174 eend $? "elisp-compile: batch-byte-compile failed" 220 eend $? "elisp-compile: batch-byte-compile failed"
175} 221}
176 222
177# #FUNCTION: elisp-comp
178# #USAGE: <list of elisp files>
179# #DESCRIPTION:
180# Byte-compile interdependent Emacs Lisp files.
181# THIS FUNCTION IS DEPRECATED.
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 ewarn "Function elisp-comp is deprecated and may be removed in future."
198 ewarn "Please use function elisp-compile instead, or report a bug about"
199 ewarn "${CATEGORY}/${PF} at <http://bugs.gentoo.org/>."
200 echo
201
202 [ $# -gt 0 ] || return 1
203
204 ebegin "Compiling GNU Emacs Elisp files"
205
206 local tempdir=elc.$$
207 mkdir ${tempdir}
208 cp "$@" ${tempdir}
209 pushd ${tempdir}
210
211 echo "(add-to-list 'load-path \"../\")" > script
212 ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el
213 local ret=$?
214 mv *.elc ..
215
216 popd
217 rm -fr ${tempdir}
218
219 eend ${ret} "elisp-comp: batch-byte-compile failed"
220}
221
222# @FUNCTION: elisp-emacs-version
223# @DESCRIPTION:
224# Output version of currently active Emacs.
225
226elisp-emacs-version() {
227 # The following will work for at least versions 18-23.
228 echo "(princ emacs-version)" >"${T}"/emacs-version.el
229 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
230 rm -f "${T}"/emacs-version.el
231}
232
233# @FUNCTION: elisp-make-autoload-file 223# @FUNCTION: elisp-make-autoload-file
234# @USAGE: [output file] [list of directories] 224# @USAGE: [output file] [list of directories]
235# @DESCRIPTION: 225# @DESCRIPTION:
236# Generate a file with autoload definitions for the lisp functions. 226# Generate a file with autoload definitions for the lisp functions.
237 227
238elisp-make-autoload-file() { 228elisp-make-autoload-file() {
239 local f="${1:-${PN}-autoloads.el}" 229 local f="${1:-${PN}-autoloads.el}" null="" page=$'\f'
240 shift 230 shift
241 ebegin "Generating autoload file for GNU Emacs" 231 ebegin "Generating autoload file for GNU Emacs"
242 232
243 sed 's/^FF/\f/' >"${f}" <<-EOF 233 cat >"${f}" <<-EOF
244 ;;; ${f##*/} --- autoloads for ${P} 234 ;;; ${f##*/} --- autoloads for ${PN}
245 235
246 ;;; Commentary: 236 ;;; Commentary:
247 ;; Automatically generated by elisp-common.eclass 237 ;; Automatically generated by elisp-common.eclass
248 ;; DO NOT EDIT THIS FILE 238 ;; DO NOT EDIT THIS FILE
249 239
250 ;;; Code: 240 ;;; Code:
251 FF 241 ${page}
252 ;; Local Variables: 242 ;; Local ${null}Variables:
253 ;; version-control: never 243 ;; version-control: never
254 ;; no-byte-compile: t 244 ;; no-byte-compile: t
255 ;; no-update-autoloads: t 245 ;; no-update-autoloads: t
256 ;; End: 246 ;; End:
247
257 ;;; ${f##*/} ends here 248 ;;; ${f##*/} ends here
258 EOF 249 EOF
259 250
260 ${EMACS} ${EMACSFLAGS} \ 251 ${EMACS} ${EMACSFLAGS} \
261 --eval "(setq make-backup-files nil)" \ 252 --eval "(setq make-backup-files nil)" \
… …
282} 273}
283 274
284# @FUNCTION: elisp-site-file-install 275# @FUNCTION: elisp-site-file-install
285# @USAGE: <site-init file> [subdirectory] 276# @USAGE: <site-init file> [subdirectory]
286# @DESCRIPTION: 277# @DESCRIPTION:
287# Install Emacs site-init file in SITELISP directory. 278# Install Emacs site-init file in SITELISP directory. Automatically
279# inserts a standard comment header with the name of the package (unless
280# it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced
281# by the path to the package's subdirectory in SITELISP and SITEETC,
282# respectively.
288 283
289elisp-site-file-install() { 284elisp-site-file-install() {
290 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret 285 local sf="${1##*/}" my_pn="${2:-${PN}}" ret
286 local header=";;; ${PN} site-lisp configuration"
287
288 [[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \
289 || ewarn "elisp-site-file-install: bad name of site-init file"
290 sf="${T}/${sf/%-gentoo*.el/-gentoo.el}"
291 ebegin "Installing site initialisation file for GNU Emacs" 291 ebegin "Installing site initialisation file for GNU Emacs"
292 cp "$1" "${sf}" 292 [[ $1 = "${sf}" ]] || cp "$1" "${sf}"
293 sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
293 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \ 294 -e "s:@SITELISP@:${EPREFIX}${SITELISP}/${my_pn}:g" \
294 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g;\$q" "${sf}" 295 -e "s:@SITEETC@:${EPREFIX}${SITEETC}/${my_pn}:g;\$q" "${sf}"
295 ( # subshell to avoid pollution of calling environment 296 ( # subshell to avoid pollution of calling environment
296 insinto "${SITELISP}/site-gentoo.d" 297 insinto "${SITELISP}/site-gentoo.d"
297 doins "${sf}" 298 doins "${sf}"
298 ) 299 )
299 ret=$? 300 ret=$?
… …
301 eend ${ret} "elisp-site-file-install: doins failed" 302 eend ${ret} "elisp-site-file-install: doins failed"
302} 303}
303 304
304# @FUNCTION: elisp-site-regen 305# @FUNCTION: elisp-site-regen
305# @DESCRIPTION: 306# @DESCRIPTION:
306# Regenerate the site-gentoo.el file, based on packages' site initialisation 307# Regenerate the site-gentoo.el file, based on packages' site
307# files in the /usr/share/emacs/site-lisp/site-gentoo.d/ directory. 308# initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
309# directory.
308# 310#
309# Note: Before December 2007, site initialisation files were installed in 311# Note: Before December 2007, site initialisation files were installed
310# /usr/share/emacs/site-lisp/. For backwards compatibility, this location is 312# in /usr/share/emacs/site-lisp/. For backwards compatibility, this
311# still supported when generating site-gentoo.el. 313# location is still supported when generating site-gentoo.el.
312 314
313elisp-site-regen() { 315elisp-site-regen() {
314 local i sf line firstrun obsolete 316 local sitelisp=${ROOT}${EPREFIX}${SITELISP}
317 local sf i line null="" page=$'\f'
315 local -a sflist 318 local -a sflist
316 # Work around Paludis borkage: variable T is empty in pkg_postrm
317 local tmpdir=${T:-$(mktemp -d)}
318 319
319 if [ ! -d "${ROOT}${SITELISP}" ]; then 320 if [[ ! -d ${sitelisp} ]]; then
320 eerror "elisp-site-regen: Directory ${SITELISP} does not exist" 321 eerror "elisp-site-regen: Directory ${sitelisp} does not exist"
321 return 1 322 return 1
322 fi 323 fi
323 324
324 [ -e "${ROOT}${SITELISP}"/site-gentoo.el ] || firstrun=t 325 if [[ ! -d ${T} ]]; then
325 326 eerror "elisp-site-regen: Temporary directory ${T} does not exist"
326 if [ "${firstrun}" ] && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then 327 return 1
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 328 fi
343 329
344 einfon "Regenerating ${SITELISP}/site-gentoo.el ..." 330 einfon "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE}) ..."
345 331
346 # remove any auxiliary file (from previous run) 332 # Until January 2009, elisp-common.eclass sometimes created an
347 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el 333 # auxiliary file for backwards compatibility. Remove any such file.
334 rm -f "${sitelisp}"/00site-gentoo.el
348 335
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 \ 336 for sf in "${sitelisp}"/[0-9][0-9]*-gentoo.el \
354 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el 337 "${sitelisp}"/site-gentoo.d/[0-9][0-9]*.el
355 do 338 do
356 [ -r "${sf}" ] || continue 339 [[ -r ${sf} ]] || continue
357 # sort files by their basename. straight insertion sort. 340 # sort files by their basename. straight insertion sort.
358 for ((i=${#sflist[@]}; i>0; i--)); do 341 for ((i=${#sflist[@]}; i>0; i--)); do
359 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break 342 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
360 sflist[i]=${sflist[i-1]} 343 sflist[i]=${sflist[i-1]}
361 done 344 done
362 sflist[i]=${sf} 345 sflist[i]=${sf}
363 # set a flag if there are obsolete files
364 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
365 done 346 done
366 347
367 eval "${old_shopts}"
368
369 cat <<-EOF >"${tmpdir}"/site-gentoo.el 348 cat <<-EOF >"${T}"/site-gentoo.el
370 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages 349 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
371 350
372 ;;; Commentary: 351 ;;; Commentary:
373 ;; Automatically generated by elisp-common.eclass 352 ;; Automatically generated by elisp-common.eclass
374 ;; DO NOT EDIT THIS FILE 353 ;; DO NOT EDIT THIS FILE
375 354
376 ;;; Code: 355 ;;; Code:
377 EOF 356 EOF
378 # Use sed instead of cat here, since files may miss a trailing newline. 357 # Use sed instead of cat here, since files may miss a trailing newline.
379 sed '$q' "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el 358 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
380 cat <<-EOF >>"${tmpdir}"/site-gentoo.el 359 cat <<-EOF >>"${T}"/site-gentoo.el
381 360
361 ${page}
382 (provide 'site-gentoo) 362 (provide 'site-gentoo)
383 363
384 ;; Local Variables: 364 ;; Local ${null}Variables:
385 ;; no-byte-compile: t 365 ;; no-byte-compile: t
366 ;; buffer-read-only: t
386 ;; End: 367 ;; End:
368
387 ;;; site-gentoo.el ends here 369 ;;; site-gentoo.el ends here
388 EOF 370 EOF
389 371
390 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el 372 if cmp -s "${sitelisp}"/site-gentoo.el "${T}"/site-gentoo.el; then
391 then
392 # This prevents outputting unnecessary text when there 373 # This prevents outputting unnecessary text when there
393 # was actually no change. 374 # was actually no change.
394 # A case is a remerge where we have doubled output. 375 # A case is a remerge where we have doubled output.
376 rm -f "${T}"/site-gentoo.el
395 echo " no changes." 377 echo " no changes."
396 else 378 else
397 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el 379 mv "${T}"/site-gentoo.el "${sitelisp}"/site-gentoo.el
398 [ -f "${tmpdir}"/site-start.el ] \
399 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
400 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
401 echo 380 echo
381 case ${#sflist[@]} in
382 0) ewarn "... Huh? No site initialisation files found." ;;
383 1) einfo "... ${#sflist[@]} site initialisation file included." ;;
402 einfo "... ${#sflist[@]} site initialisation file(s) included." 384 *) einfo "... ${#sflist[@]} site initialisation files included." ;;
385 esac
403 fi 386 fi
404
405 if [ "${firstrun}" ]; then
406 echo
407 while read line; do einfo "${line:- }"; done <<-EOF
408 All site initialisation for Gentoo-installed packages is added to
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.
412
413 In order for this site initialisation to be loaded for all users
414 automatically, you can add a line like this:
415
416 (require 'site-gentoo)
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
424 fi
425
426 if [ "${obsolete}" ]; then
427 echo
428 while read line; do ewarn "${line}"; done <<-EOF
429 Site-initialisation files of Emacs packages are now installed in
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
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 387
448 return 0 388 return 0
449} 389}
Legend:
Removed from v.1.52  
changed lines
  Added in v.1.75
  ViewVC Help
Powered by ViewVC 1.1.17